diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AccessInformationContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AccessInformationContract.tsp new file mode 100644 index 000000000000..b61ee707eef6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AccessInformationContract.tsp @@ -0,0 +1,303 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Tenant Settings. + */ +@parentResource(ApiManagementServiceResource) +model AccessInformationContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = AccessInformationContract, + KeyName = "accessName", + SegmentName = "tenant", + NamePattern = "", + Type = AccessIdName + >; +} + +@armResourceOperations +interface AccessInformationContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("tenant") + @key + configurationName: ConfigurationIdName, + } + > {} + +@armResourceOperations +interface AccessInformationContractsOperationGroup + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** The identifier of the Access configuration. */ + @path + @segment("tenant") + @key + accessName: AccessIdName, + } + > {} + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations +interface AccessInformationContracts { + /** + * Get tenant access information details without secrets. + */ + get is ArmResourceRead< + AccessInformationContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Tenant access metadata + */ + getEntityTag is ArmResourceCheckExistence< + AccessInformationContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Update tenant access information details. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + create is AccessInformationContractsOperationGroup.CreateOrUpdateSync< + AccessInformationContract, + Request = AccessInformationCreateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResourceUpdatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Update tenant access information details. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + AccessInformationContract, + PatchModel = AccessInformationUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Returns list of access infos - for Git and Management endpoints. + */ + listByService is ArmResourceListByParent< + AccessInformationContract, + Parameters = { + /** + * Not used + */ + @query("$filter") + $filter?: string; + }, + Response = ArmResponse + >; + + /** + * Regenerate primary access key + */ + regeneratePrimaryKey is ArmResourceActionSync< + AccessInformationContract, + void, + NoContentResponse + >; + + /** + * Regenerate secondary access key + */ + regenerateSecondaryKey is ArmResourceActionSync< + AccessInformationContract, + void, + NoContentResponse + >; + + /** + * Get tenant access information details. + */ + listSecrets is ArmResourceActionSync< + AccessInformationContract, + void, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Regenerate primary access key for GIT. + */ + @action("git/regeneratePrimaryKey") + tenantAccessGitRegeneratePrimaryKey is ArmResourceActionSync< + AccessInformationContract, + void, + NoContentResponse + >; + + /** + * Regenerate secondary access key for GIT. + */ + @action("git/regenerateSecondaryKey") + tenantAccessGitRegenerateSecondaryKey is ArmResourceActionSync< + AccessInformationContract, + void, + NoContentResponse + >; + + /** + * This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs( + "https://azure.microsoft.com/en-us/documentation/articles/api-management-configuration-repository-git/#to-deploy-any-service-configuration-changes-to-the-api-management-service-instance", + "To deploy any service configuration changes to the API Management service instance" + ) + deploy is AccessInformationContractOps.ActionAsync< + AccessInformationContract, + Request = DeployConfigurationParameters, + Result = void, + Response = ArmResponse | ArmAcceptedLroResponse & + Azure.Core.Foundations.RetryAfterHeader> + >; + + /** + * This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs( + "https://azure.microsoft.com/en-us/documentation/articles/api-management-configuration-repository-git/#to-save-the-service-configuration-to-the-git-repository", + "To save the service configuration to the Git repository" + ) + save is AccessInformationContractOps.ActionAsync< + AccessInformationContract, + Request = SaveConfigurationParameter, + Result = void, + Response = ArmResponse | ArmAcceptedLroResponse> + >; + + /** + * This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete. + */ + validate is AccessInformationContractOps.ActionAsync< + AccessInformationContract, + DeployConfigurationParameters, + Result = void, + Response = OperationResultContract | ArmAcceptedLroResponse> + >; + + /** + * Gets the status of the most recent synchronization between the configuration database and the Git repository. + */ + @get + @action("syncState") + getSyncState is AccessInformationContractOps.ActionSync< + AccessInformationContract, + void, + ArmResponse + >; +} + +@@doc(AccessInformationContract.name, + "The identifier of the Access configuration." +); +@@doc(AccessInformationContract.properties, + "AccessInformation entity contract properties." +); +@@doc(AccessInformationContracts.create::parameters.resource, + "Parameters supplied to retrieve the Tenant Access Information." +); +@@doc(AccessInformationContracts.update::parameters.properties, + "Parameters supplied to retrieve the Tenant Access Information." +); +@@doc(AccessInformationContracts.deploy::parameters.body, + "Deploy Configuration parameters." +); +@@doc(AccessInformationContracts.save::parameters.body, + "Save Configuration parameters." +); +@@doc(AccessInformationContracts.validate::parameters.body, + "Validate Configuration parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiContract.tsp new file mode 100644 index 000000000000..9a3713275565 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiContract.tsp @@ -0,0 +1,555 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * API details. + */ +@parentResource(ApiManagementServiceResource) +model ApiContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = ApiContract, + KeyName = "apiId", + SegmentName = "apis", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface ApiContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("apis") + @key + @minLength(1) + @maxLength(80) + apiId: string, + } + > {} + +@armResourceOperations +interface ApiContracts { + /** + * Gets the details of the API specified by its identifier. + */ + get is ApiContractOps.Read< + ApiContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the API specified by its identifier. + */ + getEntityTag is ApiContractOps.CheckExistence< + ApiContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates new or updates existing specified API of the API Management service instance. + */ + createOrUpdate is ApiContractOps.CreateOrUpdateAsync< + ApiContract, + Request = ApiCreateOrUpdateParameter, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & + ArmCombinedLroHeaders & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmResourceCreatedResponse< + ApiContract, + LroHeaders = ArmCombinedLroHeaders + > & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the specified API of the API Management service instance. + */ + @patch(#{ implicitOptionality: false }) + update is ApiContractOps.CustomPatchSync< + ApiContract, + PatchModel = ApiUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified API of the API Management service instance. + */ + delete is ApiContractOps.DeleteWithoutOkAsync< + ApiContract, + Parameters = { + /** + * Delete all revisions of the Api. + */ + @query("deleteRevisions") + deleteRevisions?: boolean; + + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmAcceptedLroResponse> | ArmNoContentResponse + >; + + /** + * Lists all APIs of the API Management service instance. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-apis") + listByService is ApiContractOps.List< + ApiContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq, ne | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * Include tags in the response. + */ + @query("tags") + tags?: string; + + /** + * Include full ApiVersionSet resource in response + */ + @query("expandApiVersionSet") + expandApiVersionSet?: boolean; + }, + Response = ArmResponse + >; + + /** + * Lists all revisions of an API. + */ + @get + @action("revisions") + @list + apiRevisionListByService is ApiContractOps.ActionSync< + ApiContract, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; + + /** + * Lists all Products, which the API is part of. + */ + @get + @action("products") + @list + listByApis is ApiContractOps.ActionSync< + ApiContract, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; + + /** + * Lists a collection of operations associated with tags. + */ + @get + @action("operationsByTags") + @list + listByTags is ApiContractOps.ActionSync< + ApiContract, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * Include not tagged Operations. + */ + @query("includeNotTaggedOperations") + includeNotTaggedOperations?: boolean; + } + >; +} +@armResourceOperations +interface WorkspaceApiOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("apis") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + apiId: string, + } + > {} + +@armResourceOperations +interface WorkspaceApi { + /** + * Gets the details of the API specified by its identifier. + */ + get is WorkspaceApiOps.Read< + ApiContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the API specified by its identifier. + */ + getEntityTag is WorkspaceApiOps.CheckExistence< + ApiContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates new or updates existing specified API of the workspace in an API Management service instance. + */ + createOrUpdate is WorkspaceApiOps.CreateOrUpdateAsync< + ApiContract, + Request = ApiCreateOrUpdateParameter, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & + ArmCombinedLroHeaders & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmResourceCreatedResponse< + ApiContract, + LroHeaders = ArmCombinedLroHeaders + > & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the specified API of the workspace in an API Management service instance. + */ + @patch(#{ implicitOptionality: false }) + update is WorkspaceApiOps.CustomPatchSync< + ApiContract, + PatchModel = ApiUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified API of the workspace in an API Management service instance. + */ + delete is WorkspaceApiOps.DeleteSync< + ApiContract, + Parameters = { + /** + * Delete all revisions of the Api. + */ + @query("deleteRevisions") + deleteRevisions?: boolean; + + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all APIs of the workspace in an API Management service instance. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-apis") + listByService is WorkspaceApiOps.List< + ApiContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq, ne | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * Include tags in the response. + */ + @query("tags") + tags?: string; + + /** + * Include full ApiVersionSet resource in response + */ + @query("expandApiVersionSet") + expandApiVersionSet?: boolean; + }, + Response = ArmResponse + >; + + /** + * Lists all revisions of an API. + */ + @get + @action("revisions") + @list + workspaceApiRevisionListByService is WorkspaceApiOps.ActionSync< + ApiContract, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; +} + +@@maxLength(ApiContract.name, 256); +@@minLength(ApiContract.name, 1); +@@doc(ApiContract.name, + "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number." +); +@@doc(ApiContract.properties, "API entity contract properties."); +@@doc(ApiContracts.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(ApiContracts.update::parameters.properties, + "API Update Contract parameters." +); +@@doc(WorkspaceApi.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(WorkspaceApi.update::parameters.properties, + "API Update Contract parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiManagementGatewayConfigConnectionResource.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiManagementGatewayConfigConnectionResource.tsp new file mode 100644 index 000000000000..cd8b18123d25 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiManagementGatewayConfigConnectionResource.tsp @@ -0,0 +1,88 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementGatewayResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * A single API Management gateway resource in List or Get response. + */ +@parentResource(ApiManagementGatewayResource) +model ApiManagementGatewayConfigConnectionResource + is Azure.ResourceManager.ProxyResource< + GatewayConfigConnectionBaseProperties, + false + > { + ...ResourceNameParameter< + Resource = ApiManagementGatewayConfigConnectionResource, + KeyName = "configConnectionName", + SegmentName = "configConnections", + NamePattern = "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + >; + + /** + * ETag of the resource. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + etag?: Azure.Core.eTag; +} + +@armResourceOperations +interface ApiManagementGatewayConfigConnectionResources { + /** + * Gets an API Management gateway config connection resource description. + */ + get is ArmResourceRead; + + /** + * Creates or updates an API Management gateway config connection. This is long running operation and could take several minutes to complete. + */ + createOrUpdate is ArmResourceCreateOrReplaceAsync; + + /** + * Deletes an existing API Management gateway config connection. + */ + delete is ArmResourceDeleteWithoutOkAsync< + ApiManagementGatewayConfigConnectionResource, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * List all API Management gateway config connections within a gateway. + */ + listByGateway is ArmResourceListByParent< + ApiManagementGatewayConfigConnectionResource, + Response = ArmResponse + >; +} + +@@maxLength(ApiManagementGatewayConfigConnectionResource.name, 30); +@@minLength(ApiManagementGatewayConfigConnectionResource.name, 1); +@@doc(ApiManagementGatewayConfigConnectionResource.name, + "The name of the API Management gateway config connection." +); +@@encodedName(ApiManagementGatewayConfigConnectionResource.etag, + "application/json", + "etag" +); +@@doc(ApiManagementGatewayConfigConnectionResource.properties, + "Properties of the API Management gateway config connection." +); +@@doc(ApiManagementGatewayConfigConnectionResources.createOrUpdate::parameters.resource, + "Parameters supplied to the CreateOrUpdate API Management gateway config connection operation." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiManagementGatewayResource.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiManagementGatewayResource.tsp new file mode 100644 index 000000000000..f39005a18043 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiManagementGatewayResource.tsp @@ -0,0 +1,124 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * A single API Management gateway resource in List or Get response. + */ +model ApiManagementGatewayResource + is Azure.ResourceManager.TrackedResource< + ApiManagementGatewayProperties, + false + > { + ...ResourceNameParameter< + Resource = ApiManagementGatewayResource, + KeyName = "gatewayName", + SegmentName = "gateways", + NamePattern = "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + >; + + /** + * SKU properties of the API Management gateway. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + sku: ApiManagementGatewaySkuProperties; + + /** + * ETag of the resource. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + etag?: Azure.Core.eTag; +} + +@armResourceOperations +interface ApiManagementGatewayResources { + /** + * Gets an API Management gateway resource description. + */ + get is ArmResourceRead; + + /** + * Creates or updates an API Management gateway. This is long running operation and could take several minutes to complete. + */ + createOrUpdate is ArmResourceCreateOrReplaceAsync< + ApiManagementGatewayResource, + LroHeaders = ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + >; + + /** + * Updates an existing API Management gateway. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync< + ApiManagementGatewayResource, + PatchModel = ApiManagementGatewayUpdateParameters + >; + + /** + * Deletes an existing API Management gateway. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/no-response-body" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + delete is ArmResourceDeleteWithoutOkAsync< + ApiManagementGatewayResource, + Response = (ArmDeleteAcceptedLroResponse & { + @bodyRoot + _: ApiManagementGatewayResource; + }) | ArmDeletedNoContentResponse + >; + + /** + * List all API Management gateways within a resource group. + */ + listByResourceGroup is ArmResourceListByParent< + ApiManagementGatewayResource, + Response = ArmResponse + >; + + /** + * List all API Management gateways within a subscription. + */ + list is ArmListBySubscription< + ApiManagementGatewayResource, + Response = ArmResponse + >; + + /** + * Gets all available SKU for a given API Management gateway + */ + @get + @action("skus") + @list + @summary("Gets available SKUs for API Management gateway") + listAvailableSkus is ArmResourceActionSync< + ApiManagementGatewayResource, + void, + ArmResponse + >; +} + +@@maxLength(ApiManagementGatewayResource.name, 45); +@@minLength(ApiManagementGatewayResource.name, 1); +@@doc(ApiManagementGatewayResource.name, + "The name of the API Management gateway." +); +@@encodedName(ApiManagementGatewayResource.etag, "application/json", "etag"); +@@doc(ApiManagementGatewayResource.properties, + "Properties of the API Management gateway." +); +@@doc(ApiManagementGatewayResources.createOrUpdate::parameters.resource, + "Parameters supplied to the CreateOrUpdate API Management gateway operation." +); +@@doc(ApiManagementGatewayResources.update::parameters.properties, + "Parameters supplied to the CreateOrUpdate API Management gateway operation." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiManagementServiceResource.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiManagementServiceResource.tsp new file mode 100644 index 000000000000..acc3e8eccc9f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiManagementServiceResource.tsp @@ -0,0 +1,875 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * A single API Management service resource in List or Get response. + */ +model ApiManagementServiceResource + is Azure.ResourceManager.TrackedResource< + ApiManagementServiceProperties, + false + > { + ...ResourceNameParameter< + Resource = ApiManagementServiceResource, + KeyName = "serviceName", + SegmentName = "service", + NamePattern = "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + >; + + /** + * SKU properties of the API Management service. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + sku: ApiManagementServiceSkuProperties; + + /** + * Managed service identity of the Api Management service. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + identity?: ApiManagementServiceIdentity; + + /** + * ETag of the resource. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + etag?: Azure.Core.eTag; + + ...Azure.ResourceManager.AvailabilityZonesProperty; +} + +@@minLength(ApiManagementServiceResource.name, 1); +@@maxLength(ApiManagementServiceResource.name, 50); + +alias QuotaCounterKeyParentParameters = { + ...ApiVersionParameter; + ...SubscriptionIdParameter; + ...ResourceGroupParameter; + + /** + * The name of the API Management service. + */ + @path + @segment("service") + @key + @minLength(1) + @maxLength(50) + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + serviceName: string; +}; + +alias QuotaCounterKeyParameters = { + /** + * Quota counter key identifier. This is the result of expression defined in `counter-key` attribute of the quota-by-key policy. For example, if you specify `counter-key="boo"` in the policy, then it’s accessible by `"boo"` counter key. But if it’s defined as `counter-key="@("b"+"a")"` then it will be accessible by `"ba"` key. + */ + @path + @key + @segment("quotas") + quotaCounterKey: string; +}; + +alias QuotaCounterKeyOps = Azure.ResourceManager.Legacy.RoutedOperations< + QuotaCounterKeyParentParameters, + QuotaCounterKeyParameters, + ResourceRoute = #{ + route: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}", + } +>; + +alias QuotaPeriodKeyParentParameters = { + ...ApiVersionParameter; + ...SubscriptionIdParameter; + ...ResourceGroupParameter; + + /** + * The name of the API Management service. + */ + @path + @segment("service") + @key + @minLength(1) + @maxLength(50) + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + serviceName: string; + + /** + * Quota counter key identifier. This is the result of expression defined in `counter-key` attribute of the quota-by-key policy. For example, if you specify `counter-key="boo"` in the policy, then it’s accessible by `"boo"` counter key. But if it’s defined as `counter-key="@("b"+"a")"` then it will be accessible by `"ba"` key. + */ + @path + @key + @segment("quotas") + quotaCounterKey: string; +}; + +alias QuotaPeriodKeyParameters = { + /** + * Quota period key identifier. + */ + @path + @key + @segment("periods") + quotaPeriodKey: string; +}; + +alias QuotaPeriodKeyOps = Azure.ResourceManager.Legacy.RoutedOperations< + QuotaPeriodKeyParentParameters, + QuotaPeriodKeyParameters, + ResourceRoute = #{ + route: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/periods", + } +>; + +@armResourceOperations(#{ allowStaticRoutes: true }) +interface ApiManagementServiceResources { + /** + * Gets an API Management service resource description. + */ + get is ArmResourceRead; + + /** + * Creates or updates an API Management service. This is long running operation and could take several minutes to complete. + */ + createOrUpdate is ArmResourceCreateOrReplaceAsync< + ApiManagementServiceResource, + LroHeaders = ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + >; + + /** + * Updates an existing API Management service. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync< + ApiManagementServiceResource, + PatchModel = ApiManagementServiceUpdateParameters + >; + + /** + * Deletes an existing API Management service. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/no-response-body" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + delete is ArmResourceDeleteWithoutOkAsync< + ApiManagementServiceResource, + Response = ArmDeletedResponse | (ArmDeleteAcceptedLroResponse & { + @bodyRoot + _: ApiManagementServiceResource; + }) | ArmDeletedNoContentResponse + >; + + /** + * List all API Management services within a resource group. + */ + listByResourceGroup is ArmResourceListByParent< + ApiManagementServiceResource, + Response = ArmResponse + >; + + /** + * Lists all API Management services within an Azure subscription. + */ + list is ArmListBySubscription< + ApiManagementServiceResource, + Response = ArmResponse + >; + + /** + * Status of all policies of API Management services. + */ + @get + @action("allPolicies") + @list + listByService is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse + >; + + /** + * Lists a collection of apis associated with tags. + */ + @get + @action("apisByTags") + @list + listByTags is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * Include not tagged APIs. + */ + @query("includeNotTaggedApis") + includeNotTaggedApis?: boolean; + } + >; + + /** + * Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("PerformConnectivityCheckAsync") + @action("connectivityCheck") + performConnectivityCheckAsync is ArmResourceActionAsync< + ApiManagementServiceResource, + ConnectivityCheckRequest, + Response = ConnectivityCheckResponse + >; + + /** + * Gets all available SKU for a given API Management service + */ + @get + @action("skus") + @list + listAvailableServiceSkus is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse + >; + + /** + * Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete. + */ + restore is ArmResourceActionAsync< + ApiManagementServiceResource, + ApiManagementServiceBackupRestoreParameters, + Response = ApiManagementServiceResource + >; + + /** + * Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete. + */ + backup is ArmResourceActionAsync< + ApiManagementServiceResource, + ApiManagementServiceBackupRestoreParameters, + Response = ApiManagementServiceResource + >; + + /** + * Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. This is long running operation and could take several minutes to complete. + */ + migrateToStv2 is ArmResourceActionAsync< + ApiManagementServiceResource, + MigrateToStv2Contract, + Response = ApiManagementServiceResource, + OptionalRequestBody = true + >; + + /** + * Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes. + */ + @action("getssotoken") + getSsoToken is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse + >; + + /** + * Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes. + */ + @action("applynetworkconfigurationupdates") + applyNetworkConfigurationUpdates is ArmResourceActionAsync< + ApiManagementServiceResource, + ApiManagementServiceApplyNetworkConfigurationParameters, + Response = ApiManagementServiceResource, + OptionalRequestBody = true + >; + + /** + * Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService. + */ + @get + @action("networkstatus") + networkStatusListByService is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse + >; + + /** + * Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService. + */ + @get + @action("networkstatus") + listByLocation is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse, + Parameters = { + /** + * Location in which the API Management service is deployed. This is one of the Azure Regions like West US, East US, South Central US. + */ + @minLength(1) + @path + @segment("locations") + locationName: string; + } + >; + + /** + * Gets the network endpoints of all outbound dependencies of a ApiManagement service. + */ + @get + @action("outboundNetworkDependenciesEndpoints") + outboundNetworkDependenciesEndpointsListByService is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse + >; + + /** + * Lists all policy descriptions. + */ + @get + @action("policyDescriptions") + policyDescriptionListByService is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse, + Parameters = { + /** + * Policy scope. + */ + @query("scope") + scope?: PolicyScopeContract; + } + >; + + /** + * Validate all policies of API Management services. + */ + @action("validatePolicies") + byService is ArmResourceActionAsync< + ApiManagementServiceResource, + void, + Response = OperationResultContract + >; + + /** + * Lists a collection of portalsettings defined within a service instance.. + */ + #deprecated "deprecated" + @get + @action("portalsettings") + portalSettingsListByService is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse + >; + + /** + * Lists a collection of products associated with tags. + */ + @get + @action("productsByTags") + @list + productListByTags is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * Include not tagged Products. + */ + @query("includeNotTaggedProducts") + includeNotTaggedProducts?: boolean; + } + >; + + /** + * Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @get + @externalDocs( + "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies", + "Document describing how to configure the quota policies." + ) + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}") + quotaByCounterKeysListByService is QuotaCounterKeyOps.ActionSync< + ApiManagementServiceResource, + void, + Response = ArmResponse + >; + + /** + * Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @patch(#{ implicitOptionality: true }) + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}") + quotaByCounterKeysUpdate is QuotaCounterKeyOps.ActionSync< + ApiManagementServiceResource, + Request = QuotaCounterValueUpdateContract, + Response = ArmResponse + >; + + /** + * Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @get + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/periods/{quotaPeriodKey}") + @externalDocs( + "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies", + "Document describing how to configure the quota policies." + ) + quotaByPeriodKeysGet is QuotaPeriodKeyOps.ActionSync< + ApiManagementServiceResource, + void, + Response = ArmResponse + >; + + /** + * Updates an existing quota counter value in the specified service instance. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @patch(#{ implicitOptionality: true }) + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/periods/{quotaPeriodKey}") + quotaByPeriodKeysUpdate is QuotaPeriodKeyOps.ActionSync< + ApiManagementServiceResource, + QuotaCounterValueUpdateContract, + Response = ArmResponse + >; + + /** + * Lists all azure regions in which the service exists. + */ + @get + @action("regions") + @list + regionListByService is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse + >; + + /** + * Lists report records by API. + */ + @get + @action("reports/byApi") + @list + listByApi is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse, + Parameters = { + /** + * The filter to apply on the operation. + */ + @query("$filter") + $filter: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * OData order by query option. + */ + @query("$orderby") + $orderby?: string; + } + >; + + /** + * Lists report records by User. + */ + @get + @action("reports/byUser") + @list + listByUser is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| userId | select, filter | eq | |
| apiRegion | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
+ */ + @query("$filter") + $filter: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * OData order by query option. + */ + @query("$orderby") + $orderby?: string; + } + >; + + /** + * Lists report records by API Operations. + */ + @get + @action("reports/byOperation") + @list + listByOperation is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | select, filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
+ */ + @query("$filter") + $filter: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * OData order by query option. + */ + @query("$orderby") + $orderby?: string; + } + >; + + /** + * Lists report records by Product. + */ + @get + @action("reports/byProduct") + @list + listByProduct is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | select, filter | eq | |
| subscriptionId | filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
+ */ + @query("$filter") + $filter: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * OData order by query option. + */ + @query("$orderby") + $orderby?: string; + } + >; + + /** + * Lists report records by geography. + */ + @get + @action("reports/byGeo") + @list + listByGeo is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| country | select | | |
| region | select | | |
| zip | select | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select | | |
| callCountBlocked | select | | |
| callCountFailed | select | | |
| callCountOther | select | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
+ */ + @query("$filter") + $filter: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; + + /** + * Lists report records by subscription. + */ + @get + @action("reports/bySubscription") + @list + listBySubscription is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | select, filter | eq | |
| productId | select, filter | eq | |
| subscriptionId | select, filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
+ */ + @query("$filter") + $filter: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * OData order by query option. + */ + @query("$orderby") + $orderby?: string; + } + >; + + /** + * Lists report records by Time. + */ + @get + @action("reports/byTime") + @list + listByTime is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter, select | ge, le | |
| interval | select | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select | | |
| callCountBlocked | select | | |
| callCountFailed | select | | |
| callCountOther | select | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
+ */ + @query("$filter") + $filter: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * OData order by query option. + */ + @query("$orderby") + $orderby?: string; + + /** + * By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)). + */ + @query("interval") + interval: duration; + } + >; + + /** + * Lists report records by Request. + */ + @get + @action("reports/byRequest") + @list + listByRequest is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| productId | filter | eq | |
| userId | filter | eq | |
| apiRegion | filter | eq | |
| subscriptionId | filter | eq | |
+ */ + @query("$filter") + $filter: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; + + /** + * Lists a collection of resources associated with tags. + */ + @get + @action("tagResources") + @list + tagResourceListByService is ArmResourceActionSync< + ApiManagementServiceResource, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| aid | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| isCurrent | filter | eq | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; +} + +@@maxLength(ApiManagementServiceResource.name, 50); +@@minLength(ApiManagementServiceResource.name, 1); +@@doc(ApiManagementServiceResource.name, + "The name of the API Management service." +); +@@encodedName(ApiManagementServiceResource.etag, "application/json", "etag"); +@@doc(ApiManagementServiceResource.properties, + "Properties of the API Management service." +); +@@doc(ApiManagementServiceResources.createOrUpdate::parameters.resource, + "Parameters supplied to the CreateOrUpdate API Management service operation." +); +@@doc(ApiManagementServiceResources.update::parameters.properties, + "Parameters supplied to the CreateOrUpdate API Management service operation." +); +@@doc(ApiManagementServiceResources.performConnectivityCheckAsync::parameters.body, + "Connectivity Check request parameters." +); +@@doc(ApiManagementServiceResources.restore::parameters.body, + "Parameters supplied to the Restore API Management service from backup operation." +); +@@doc(ApiManagementServiceResources.backup::parameters.body, + "Parameters supplied to the ApiManagementService_Backup operation." +); +@@doc(ApiManagementServiceResources.migrateToStv2::parameters.body, + "Optional parameters supplied to migrate service." +); +@@doc(ApiManagementServiceResources.applyNetworkConfigurationUpdates::parameters.body, + "Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region." +); +@@doc(ApiManagementServiceResources.quotaByCounterKeysUpdate::parameters.body, + "The value of the quota counter to be applied to all quota counter periods." +); +@@doc(ApiManagementServiceResources.quotaByPeriodKeysUpdate::parameters.body, + "The value of the Quota counter to be applied on the specified period." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiManagementWorkspaceLinksResource.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiManagementWorkspaceLinksResource.tsp new file mode 100644 index 000000000000..b91d675ef26b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiManagementWorkspaceLinksResource.tsp @@ -0,0 +1,65 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * A single API Management WorkspaceLinks in List or Get response. + */ +@parentResource(ApiManagementServiceResource) +model ApiManagementWorkspaceLinksResource + is Azure.ResourceManager.ProxyResource< + ApiManagementWorkspaceLinksProperties, + false + > { + ...ResourceNameParameter< + Resource = ApiManagementWorkspaceLinksResource, + KeyName = "workspaceId", + SegmentName = "workspaceLinks", + NamePattern = "^[^*#&+:<>?]+$" + >; + + /** + * ETag of the resource. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + etag?: Azure.Core.eTag; +} + +@armResourceOperations +interface ApiManagementWorkspaceLinksResources { + /** + * Gets an API Management WorkspaceLink resource description. + */ + get is ArmResourceRead; + + /** + * List all API Management workspaceLinks for a service. + */ + listByService is ArmResourceListByParent< + ApiManagementWorkspaceLinksResource, + Response = ArmResponse + >; +} + +@@maxLength(ApiManagementWorkspaceLinksResource.name, 80); +@@minLength(ApiManagementWorkspaceLinksResource.name, 1); +@@doc(ApiManagementWorkspaceLinksResource.name, + "Workspace identifier. Must be unique in the current API Management service instance." +); +@@encodedName(ApiManagementWorkspaceLinksResource.etag, + "application/json", + "etag" +); +@@doc(ApiManagementWorkspaceLinksResource.properties, + "Properties of the API Management WorkspaceLinks." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiReleaseContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiReleaseContract.tsp new file mode 100644 index 000000000000..f8c68ea64501 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiReleaseContract.tsp @@ -0,0 +1,383 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * ApiRelease details. + */ +@parentResource(ApiContract) +model ApiReleaseContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = ApiReleaseContract, + KeyName = "releaseId", + SegmentName = "releases", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface ApiReleaseContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** API identifier. Must be unique in the current API Management service instance. */ + @path + @segment("apis") + @key + @minLength(1) + @maxLength(80) + apiId: string, + }, + { + /** Release identifier within an API. Must be unique in the current API Management service instance. */ + @path + @segment("releases") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + releaseId: string, + } + > {} + +@armResourceOperations +interface ApiReleaseContracts { + /** + * Returns the details of an API release. + */ + get is ApiReleaseContractOps.Read< + ApiReleaseContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Returns the etag of an API release. + */ + getEntityTag is ApiReleaseContractOps.CheckExistence< + ApiReleaseContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new Release for the API. + */ + createOrUpdate is ApiReleaseContractOps.CreateOrUpdateSync< + ApiReleaseContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the release of the API specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is ApiReleaseContractOps.CustomPatchSync< + ApiReleaseContract, + PatchModel = ApiReleaseContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified release in the API. + */ + delete is ApiReleaseContractOps.DeleteSync< + ApiReleaseContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters. + */ + listByService is ApiReleaseContractOps.List< + ApiReleaseContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| notes | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceApiReleaseOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + + /** API identifier. Must be unique in the current API Management service instance. */ + @path + @segment("apis") + @key + @minLength(1) + @maxLength(80) + apiId: string, + }, + { + /** Release identifier within an API. Must be unique in the current API Management service instance. */ + @path + @segment("releases") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + releaseId: string, + } + > {} + +@armResourceOperations +interface WorkspaceApiRelease { + /** + * Returns the details of an API release. + */ + get is WorkspaceApiReleaseOps.Read< + ApiReleaseContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Returns the etag of an API release. + */ + getEntityTag is WorkspaceApiReleaseOps.CheckExistence< + ApiReleaseContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new Release for the API. + */ + createOrUpdate is WorkspaceApiReleaseOps.CreateOrUpdateSync< + ApiReleaseContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the release of the API specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is WorkspaceApiReleaseOps.CustomPatchSync< + ApiReleaseContract, + PatchModel = ApiReleaseContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified release in the API. + */ + delete is WorkspaceApiReleaseOps.DeleteSync< + ApiReleaseContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters. + */ + listByService is WorkspaceApiReleaseOps.List< + ApiReleaseContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| notes | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(ApiReleaseContract.name, 80); +@@minLength(ApiReleaseContract.name, 1); +@@doc(ApiReleaseContract.name, + "Release identifier within an API. Must be unique in the current API Management service instance." +); +@@doc(ApiReleaseContract.properties, "ApiRelease entity contract properties."); +@@doc(ApiReleaseContracts.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(ApiReleaseContracts.update::parameters.properties, + "API Release Update parameters." +); +@@doc(WorkspaceApiRelease.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(WorkspaceApiRelease.update::parameters.properties, + "API Release Update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiVersionSetContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiVersionSetContract.tsp new file mode 100644 index 000000000000..a9c355a1fc13 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ApiVersionSetContract.tsp @@ -0,0 +1,368 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * API Version Set Contract details. + */ +@parentResource(ApiManagementServiceResource) +model ApiVersionSetContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = ApiVersionSetContract, + KeyName = "versionSetId", + SegmentName = "apiVersionSets", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface ApiVersionSetContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** Api Version Set identifier. Must be unique in the current API Management service instance. */ + @path + @segment("apiVersionSets") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + versionSetId: string, + } + > {} + +@armResourceOperations +interface ApiVersionSetContracts { + /** + * Gets the details of the Api Version Set specified by its identifier. + */ + get is ApiVersionSetContractOps.Read< + ApiVersionSetContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Api Version Set specified by its identifier. + */ + getEntityTag is ApiVersionSetContractOps.CheckExistence< + ApiVersionSetContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or Updates a Api Version Set. + */ + createOrUpdate is ApiVersionSetContractOps.CreateOrUpdateSync< + ApiVersionSetContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the Api VersionSet specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is ApiVersionSetContractOps.CustomPatchSync< + ApiVersionSetContract, + PatchModel = ApiVersionSetUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes specific Api Version Set. + */ + delete is ApiVersionSetContractOps.DeleteSync< + ApiVersionSetContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of API Version Sets in the specified service instance. + */ + listByService is ApiVersionSetContractOps.List< + ApiVersionSetContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @query("$skip") + @minValue(0) + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceApiVersionSetOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** Api Version Set identifier. Must be unique in the current API Management service instance. */ + @path + @segment("apiVersionSets") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + versionSetId: string, + } + > {} + +@armResourceOperations +interface WorkspaceApiVersionSet { + /** + * Gets the details of the Api Version Set specified by its identifier. + */ + get is WorkspaceApiVersionSetOps.Read< + ApiVersionSetContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Api Version Set specified by its identifier. + */ + getEntityTag is WorkspaceApiVersionSetOps.CheckExistence< + ApiVersionSetContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or Updates a Api Version Set. + */ + createOrUpdate is WorkspaceApiVersionSetOps.CreateOrUpdateSync< + ApiVersionSetContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the Api VersionSet specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is WorkspaceApiVersionSetOps.CustomPatchSync< + ApiVersionSetContract, + PatchModel = ApiVersionSetUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes specific Api Version Set. + */ + delete is WorkspaceApiVersionSetOps.DeleteSync< + ApiVersionSetContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of API Version Sets in the specified workspace with a service instance. + */ + listByService is WorkspaceApiVersionSetOps.List< + ApiVersionSetContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(ApiVersionSetContract.name, 80); +@@minLength(ApiVersionSetContract.name, 1); + +@@doc(ApiVersionSetContract.name, + "Api Version Set identifier. Must be unique in the current API Management service instance." +); +@@doc(ApiVersionSetContract.properties, "API VersionSet contract properties."); +@@doc(ApiVersionSetContracts.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(ApiVersionSetContracts.update::parameters.properties, + "Update parameters." +); +@@doc(WorkspaceApiVersionSet.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(WorkspaceApiVersionSet.update::parameters.properties, + "Update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AuthorizationAccessPolicyContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AuthorizationAccessPolicyContract.tsp new file mode 100644 index 000000000000..900e7b82b237 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AuthorizationAccessPolicyContract.tsp @@ -0,0 +1,127 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./AuthorizationContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Authorization access policy contract. + */ +@parentResource(AuthorizationContract) +model AuthorizationAccessPolicyContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = AuthorizationAccessPolicyContract, + KeyName = "authorizationAccessPolicyId", + SegmentName = "accessPolicies", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface AuthorizationAccessPolicyContracts { + /** + * Gets the details of the authorization access policy specified by its identifier. + */ + get is ArmResourceRead< + AuthorizationAccessPolicyContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates Authorization Access Policy. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + AuthorizationAccessPolicyContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes specific access policy from the Authorization. + */ + delete is ArmResourceDeleteSync< + AuthorizationAccessPolicyContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of authorization access policy defined within a authorization. + */ + listByAuthorization is ArmResourceListByParent< + AuthorizationAccessPolicyContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(AuthorizationAccessPolicyContract.name, 256); +@@minLength(AuthorizationAccessPolicyContract.name, 1); +@@doc(AuthorizationAccessPolicyContract.name, + "Identifier of the authorization access policy." +); +@@doc(AuthorizationAccessPolicyContract.properties, + "Properties of the Authorization Contract." +); +@@doc(AuthorizationAccessPolicyContracts.createOrUpdate::parameters.resource, + "Create parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AuthorizationContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AuthorizationContract.tsp new file mode 100644 index 000000000000..771f0bb5d7d7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AuthorizationContract.tsp @@ -0,0 +1,160 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./AuthorizationProviderContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Authorization contract. + */ +@parentResource(AuthorizationProviderContract) +model AuthorizationContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = AuthorizationContract, + KeyName = "authorizationId", + SegmentName = "authorizations", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface AuthorizationContracts { + /** + * Gets the details of the authorization specified by its identifier. + */ + get is ArmResourceRead< + AuthorizationContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates authorization. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + AuthorizationContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes specific Authorization from the Authorization provider. + */ + delete is ArmResourceDeleteSync< + AuthorizationContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of authorization providers defined within a authorization provider. + */ + listByAuthorizationProvider is ArmResourceListByParent< + AuthorizationContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; + + /** + * Confirm valid consent code to suppress Authorizations anti-phishing page. + */ + confirmConsentCode is ArmResourceActionSync< + AuthorizationContract, + AuthorizationConfirmConsentCodeRequestContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets authorization login links. + */ + @action("getLoginLinks") + post is ArmResourceActionSync< + AuthorizationContract, + AuthorizationLoginRequestContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; +} + +@@maxLength(AuthorizationContract.name, 256); +@@minLength(AuthorizationContract.name, 1); +@@doc(AuthorizationContract.name, "Identifier of the authorization."); +@@doc(AuthorizationContract.properties, + "Properties of the Authorization Contract." +); +@@doc(AuthorizationContracts.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(AuthorizationContracts.confirmConsentCode::parameters.body, + "Create parameters." +); +@@doc(AuthorizationContracts.post::parameters.body, "Create parameters."); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AuthorizationProviderContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AuthorizationProviderContract.tsp new file mode 100644 index 000000000000..0f8cc90f8dd8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AuthorizationProviderContract.tsp @@ -0,0 +1,127 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Authorization Provider contract. + */ +@parentResource(ApiManagementServiceResource) +model AuthorizationProviderContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = AuthorizationProviderContract, + KeyName = "authorizationProviderId", + SegmentName = "authorizationProviders", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface AuthorizationProviderContracts { + /** + * Gets the details of the authorization provider specified by its identifier. + */ + get is ArmResourceRead< + AuthorizationProviderContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates authorization provider. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + AuthorizationProviderContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes specific authorization provider from the API Management service instance. + */ + delete is ArmResourceDeleteSync< + AuthorizationProviderContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of authorization providers defined within a service instance. + */ + listByService is ArmResourceListByParent< + AuthorizationProviderContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(AuthorizationProviderContract.name, 256); +@@minLength(AuthorizationProviderContract.name, 1); +@@doc(AuthorizationProviderContract.name, + "Identifier of the authorization provider." +); +@@doc(AuthorizationProviderContract.properties, + "Properties of the Authorization Provider Contract." +); +@@doc(AuthorizationProviderContracts.createOrUpdate::parameters.resource, + "Create parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AuthorizationServerContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AuthorizationServerContract.tsp new file mode 100644 index 000000000000..c09d9548ddb2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/AuthorizationServerContract.tsp @@ -0,0 +1,183 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * External OAuth authorization server settings. + */ +@parentResource(ApiManagementServiceResource) +model AuthorizationServerContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = AuthorizationServerContract, + KeyName = "authsid", + SegmentName = "authorizationServers", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface AuthorizationServerContracts { + /** + * Gets the details of the authorization server specified by its identifier. + */ + get is ArmResourceRead< + AuthorizationServerContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the authorizationServer specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + AuthorizationServerContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates new authorization server or updates an existing authorization server. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + AuthorizationServerContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the authorization server specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + AuthorizationServerContract, + PatchModel = AuthorizationServerUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes specific authorization server instance. + */ + delete is ArmResourceDeleteSync< + AuthorizationServerContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of authorization servers defined within a service instance. + */ + listByService is ArmResourceListByParent< + AuthorizationServerContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; + + /** + * Gets the client secret details of the authorization server. + */ + listSecrets is ArmResourceActionSync< + AuthorizationServerContract, + void, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; +} + +@@maxLength(AuthorizationServerContract.name, 80); +@@minLength(AuthorizationServerContract.name, 1); +@@doc(AuthorizationServerContract.name, + "Identifier of the authorization server." +); +@@doc(AuthorizationServerContract.properties, + "Properties of the External OAuth authorization server Contract." +); +@@doc(AuthorizationServerContracts.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(AuthorizationServerContracts.update::parameters.properties, + "OAuth2 Server settings Update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/BackendContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/BackendContract.tsp new file mode 100644 index 000000000000..7d94437eb9e8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/BackendContract.tsp @@ -0,0 +1,376 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Backend details. + */ +@parentResource(ApiManagementServiceResource) +model BackendContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = BackendContract, + KeyName = "backendId", + SegmentName = "backends", + NamePattern = "" + >; +} + +@armResourceOperations +interface BackendContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** Identifier of the Backend entity. Must be unique in the current API Management service instance. */ + @path + @segment("backends") + @key + @minLength(1) + @maxLength(80) + backendId: string, + } + > {} + +@armResourceOperations +interface BackendContracts { + /** + * Gets the details of the backend specified by its identifier. + */ + get is BackendContractOps.Read< + BackendContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the backend specified by its identifier. + */ + getEntityTag is BackendContractOps.CheckExistence< + BackendContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or Updates a backend. + */ + createOrUpdate is BackendContractOps.CreateOrUpdateSync< + BackendContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates an existing backend. + */ + @patch(#{ implicitOptionality: false }) + update is BackendContractOps.CustomPatchSync< + BackendContract, + PatchModel = BackendUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified backend. + */ + delete is BackendContractOps.DeleteSync< + BackendContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of backends in the specified service instance. + */ + listByService is BackendContractOps.List< + BackendContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; + + /** + * Notifies the API Management gateway to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + reconnect is BackendContractOps.ActionSync< + BackendContract, + BackendReconnectContract, + AcceptedResponse, + OptionalRequestBody = true + >; +} +@armResourceOperations +interface WorkspaceBackendOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** Identifier of the Backend entity. Must be unique in the current API Management service instance. */ + @path + @segment("backends") + @key + @minLength(1) + @maxLength(80) + backendId: string, + } + > {} + +@armResourceOperations +interface WorkspaceBackend { + /** + * Gets the details of the backend specified by its identifier. + */ + get is WorkspaceBackendOps.Read< + BackendContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the backend specified by its identifier. + */ + getEntityTag is WorkspaceBackendOps.CheckExistence< + BackendContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or Updates a backend. + */ + createOrUpdate is WorkspaceBackendOps.CreateOrUpdateSync< + BackendContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates an existing backend. + */ + @patch(#{ implicitOptionality: false }) + update is WorkspaceBackendOps.CustomPatchSync< + BackendContract, + PatchModel = BackendUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified backend. + */ + delete is WorkspaceBackendOps.DeleteSync< + BackendContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of backends in the specified workspace. + */ + listByWorkspace is WorkspaceBackendOps.List< + BackendContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(BackendContract.name, 80); +@@minLength(BackendContract.name, 1); +@@doc(BackendContract.name, + "Identifier of the Backend entity. Must be unique in the current API Management service instance." +); +@@doc(BackendContract.properties, "Backend entity contract properties."); +@@doc(BackendContracts.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(BackendContracts.update::parameters.properties, "Update parameters."); +@@doc(BackendContracts.reconnect::parameters.body, + "Reconnect request parameters." +); +@@doc(WorkspaceBackend.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(WorkspaceBackend.update::parameters.properties, "Update parameters."); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/CacheContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/CacheContract.tsp new file mode 100644 index 000000000000..237ba997da9d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/CacheContract.tsp @@ -0,0 +1,163 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Cache details. + */ +@parentResource(ApiManagementServiceResource) +model CacheContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = CacheContract, + KeyName = "cacheId", + SegmentName = "caches", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface CacheContracts { + /** + * Gets the details of the Cache specified by its identifier. + */ + get is ArmResourceRead< + CacheContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Cache specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + CacheContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates an External Cache to be used in Api Management instance. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs( + "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-cache-external", + "Use an external cache in Azure API Management" + ) + createOrUpdate is ArmResourceCreateOrReplaceSync< + CacheContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the cache specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + CacheContract, + PatchModel = CacheUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes specific Cache. + */ + delete is ArmResourceDeleteSync< + CacheContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of all external Caches in the specified service instance. + */ + listByService is ArmResourceListByParent< + CacheContract, + Parameters = { + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(CacheContract.name, 80); +@@minLength(CacheContract.name, 1); +@@doc(CacheContract.name, + "Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier)." +); +@@doc(CacheContract.properties, "Cache properties details."); +@@doc(CacheContracts.createOrUpdate::parameters.resource, + "Create or Update parameters." +); +@@doc(CacheContracts.update::parameters.properties, "Update parameters."); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/CertificateContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/CertificateContract.tsp new file mode 100644 index 000000000000..8670722777b0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/CertificateContract.tsp @@ -0,0 +1,377 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Certificate details. + */ +@parentResource(ApiManagementServiceResource) +model CertificateContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = CertificateContract, + KeyName = "certificateId", + SegmentName = "certificates", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface CertificateContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** Identifier of the certificate entity. Must be unique in the current API Management service instance. */ + @path + @segment("certificates") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + certificateId: string, + } + > {} + +@armResourceOperations +interface CertificateContracts { + /** + * Gets the details of the certificate specified by its identifier. + */ + get is CertificateContractOps.Read< + CertificateContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the certificate specified by its identifier. + */ + getEntityTag is CertificateContractOps.CheckExistence< + CertificateContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates the certificate being used for authentication with the backend. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs( + "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/", + "How to secure back-end services using client certificate authentication in Azure API Management" + ) + createOrUpdate is CertificateContractOps.CreateOrUpdateSync< + CertificateContract, + Request = CertificateCreateOrUpdateParameters, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes specific certificate. + */ + delete is CertificateContractOps.DeleteSync< + CertificateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of all certificates in the specified service instance. + */ + listByService is CertificateContractOps.List< + CertificateContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| expirationDate | filter | ge, le, eq, ne, gt, lt | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * When set to true, the response contains only certificates entities which failed refresh. + */ + @query("isKeyVaultRefreshFailed") + isKeyVaultRefreshFailed?: boolean; + }, + Response = ArmResponse + >; + + /** + * From KeyVault, Refresh the certificate being used for authentication with the backend. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs( + "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/", + "How to secure back-end services using client certificate authentication in Azure API Management" + ) + refreshSecret is CertificateContractOps.ActionSync< + CertificateContract, + void, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; +} +@armResourceOperations +interface WorkspaceCertificateOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** Identifier of the certificate entity. Must be unique in the current API Management service instance. */ + @path + @segment("certificates") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + certificateId: string, + } + > {} + +@armResourceOperations +interface WorkspaceCertificate { + /** + * Gets the details of the certificate specified by its identifier. + */ + get is WorkspaceCertificateOps.Read< + CertificateContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the certificate specified by its identifier. + */ + getEntityTag is WorkspaceCertificateOps.CheckExistence< + CertificateContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates the certificate being used for authentication with the backend. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs( + "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/", + "How to secure back-end services using client certificate authentication in Azure API Management" + ) + createOrUpdate is WorkspaceCertificateOps.CreateOrUpdateSync< + CertificateContract, + Request = CertificateCreateOrUpdateParameters, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes specific certificate. + */ + delete is WorkspaceCertificateOps.DeleteSync< + CertificateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of all certificates in the specified workspace. + */ + listByWorkspace is WorkspaceCertificateOps.List< + CertificateContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| expirationDate | filter | ge, le, eq, ne, gt, lt | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * When set to true, the response contains only certificates entities which failed refresh. + */ + @query("isKeyVaultRefreshFailed") + isKeyVaultRefreshFailed?: boolean; + }, + Response = ArmResponse + >; + + /** + * From KeyVault, Refresh the certificate being used for authentication with the backend. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs( + "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/", + "How to secure back-end services using client certificate authentication in Azure API Management" + ) + refreshSecret is WorkspaceCertificateOps.ActionSync< + CertificateContract, + void, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; +} + +@@maxLength(CertificateContract.name, 80); +@@minLength(CertificateContract.name, 1); +@@doc(CertificateContract.name, + "Identifier of the certificate entity. Must be unique in the current API Management service instance." +); +@@doc(CertificateContract.properties, "Certificate properties details."); +@@doc(CertificateContracts.createOrUpdate::parameters.resource, + "Create or Update parameters." +); +@@doc(WorkspaceCertificate.createOrUpdate::parameters.resource, + "Create or Update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ClientApplicationContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ClientApplicationContract.tsp new file mode 100644 index 000000000000..12b6a0b4f965 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ClientApplicationContract.tsp @@ -0,0 +1,132 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Client application details. + */ +@parentResource(ApiManagementServiceResource) +model ClientApplicationContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = ClientApplicationContract, + KeyName = "clientApplicationId", + SegmentName = "clientApplications", + NamePattern = "" + >; +} + +@armResourceOperations +interface ClientApplicationContracts { + /** + * Gets the details of the client application specified by its identifier. + */ + get is ArmResourceRead< + ClientApplicationContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the product specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + ClientApplicationContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or Updates a client application. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + ClientApplicationContract, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Delete client application. + */ + delete is ArmResourceDeleteSync; + + /** + * Lists a collection of client applications in the specified service instance. + */ + listByService is ArmResourceListByParent< + ClientApplicationContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
state | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| + */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; + + /** + * Retrived client application secrets. + */ + listSecrets is ArmResourceActionSync< + ClientApplicationContract, + void, + ArmResponse + >; +} + +@@maxLength(ClientApplicationContract.name, 256); +@@minLength(ClientApplicationContract.name, 1); +@@doc(ClientApplicationContract.name, + "Client Application identifier. Must be unique in the current API Management service instance." +); +@@doc(ClientApplicationContract.properties, + "Client application entity contract properties." +); +@@doc(ClientApplicationContracts.createOrUpdate::parameters.resource, + "Create or update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ClientApplicationProductLinkContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ClientApplicationProductLinkContract.tsp new file mode 100644 index 000000000000..284f2e28995e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ClientApplicationProductLinkContract.tsp @@ -0,0 +1,88 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ClientApplicationContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Specifies Client Application - Product link assignment + */ +@parentResource(ClientApplicationContract) +model ClientApplicationProductLinkContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = ClientApplicationProductLinkContract, + KeyName = "clientApplicationProductLinkId", + SegmentName = "productLinks", + NamePattern = "" + >; +} + +@armResourceOperations +interface ClientApplicationProductLinkContracts { + /** + * Gets the product link for the client application. + */ + get is ArmResourceRead< + ClientApplicationProductLinkContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Adds an Product to the specified Client Application via link. + */ + create is ArmResourceCreateOrReplaceSync; + + /** + * Deletes the specified Product from the specified client application. + */ + delete is ArmResourceDeleteSync; + + /** + * Lists a collection of product links associated with the specified client application. + */ + listByClientApplications is ArmResourceListByParent< + ClientApplicationProductLinkContract, + Parameters = { + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(ClientApplicationProductLinkContract.name, 256); +@@minLength(ClientApplicationProductLinkContract.name, 1); +@@doc(ClientApplicationProductLinkContract.name, + "Client Application Product Link identifier. Must be unique in the current API Management service instance." +); +@@doc(ClientApplicationProductLinkContract.properties, + "Client application - product link entity contract properties." +); +@@doc(ClientApplicationProductLinkContracts.create::parameters.resource, + "Create parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ContentItemContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ContentItemContract.tsp new file mode 100644 index 000000000000..ee8598f7cf6e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ContentItemContract.tsp @@ -0,0 +1,116 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ContentTypeContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Content type contract details. + */ +@parentResource(ContentTypeContract) +model ContentItemContract + is Azure.ResourceManager.ProxyResource> { + ...ResourceNameParameter< + Resource = ContentItemContract, + KeyName = "contentItemId", + SegmentName = "contentItems", + NamePattern = "" + >; +} + +@armResourceOperations +interface ContentItemContracts { + /** + * Returns the developer portal's content item specified by its identifier. + */ + get is ArmResourceRead< + ContentItemContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Returns the entity state (ETag) version of the developer portal's content item specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + ContentItemContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new developer portal's content item specified by the provided content type. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + ContentItemContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Removes the specified developer portal's content item. + */ + delete is ArmResourceDeleteSync< + ContentItemContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists developer portal's content items specified by the provided content type. + */ + listByService is ArmResourceListByParent< + ContentItemContract, + Response = ArmResponse + >; +} + +@@maxLength(ContentItemContract.name, 80); +@@minLength(ContentItemContract.name, 1); +@@doc(ContentItemContract.name, "Content item identifier."); +@@doc(ContentItemContract.properties, "Properties of the content item."); +@@doc(ContentItemContracts.createOrUpdate::parameters.resource, + "Create or update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ContentTypeContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ContentTypeContract.tsp new file mode 100644 index 000000000000..f95eb753d3ee --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ContentTypeContract.tsp @@ -0,0 +1,102 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Content type contract details. + */ +@parentResource(ApiManagementServiceResource) +model ContentTypeContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = ContentTypeContract, + KeyName = "contentTypeId", + SegmentName = "contentTypes", + NamePattern = "" + >; +} + +@armResourceOperations +interface ContentTypeContracts { + /** + * Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. + */ + get is ArmResourceRead< + ContentTypeContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the `c-` prefix. Built-in content types can't be modified. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + ContentTypeContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the `c-` prefix) can't be removed. + */ + delete is ArmResourceDeleteSync< + ContentTypeContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints. + */ + listByService is ArmResourceListByParent< + ContentTypeContract, + Response = ArmResponse + >; +} + +@@maxLength(ContentTypeContract.name, 80); +@@minLength(ContentTypeContract.name, 1); +@@doc(ContentTypeContract.name, "Content type identifier."); +@@doc(ContentTypeContract.properties, "Properties of the content type."); +@@doc(ContentTypeContracts.createOrUpdate::parameters.resource, + "Create or update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/DeletedServiceContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/DeletedServiceContract.tsp new file mode 100644 index 000000000000..949a94c53c4c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/DeletedServiceContract.tsp @@ -0,0 +1,65 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Deleted API Management Service information. + */ +@subscriptionResource +@parentResource(SubscriptionLocationResource) +model DeletedServiceContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = DeletedServiceContract, + KeyName = "serviceName", + SegmentName = "deletedservices", + NamePattern = "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + >; + + /** + * API Management Service Master Location. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + location?: string; +} + +@armResourceOperations +interface DeletedServiceContracts { + /** + * Get soft-deleted Api Management Service by name. + */ + getByName is ArmResourceRead< + DeletedServiceContract, + BaseParameters = Azure.ResourceManager.Foundations.SubscriptionBaseParameters + >; + + /** + * Purges Api Management Service (deletes it with no option to undelete). + */ + #suppress "@azure-tools/typespec-azure-resource-manager/no-response-body" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + purge is ArmResourceDeleteWithoutOkAsync< + DeletedServiceContract, + BaseParameters = Azure.ResourceManager.Foundations.SubscriptionBaseParameters, + Response = ArmDeletedResponse | (ArmDeleteAcceptedLroResponse & { + @bodyRoot + _: DeletedServiceContract; + }) | ArmDeletedNoContentResponse + >; +} + +@@maxLength(DeletedServiceContract.name, 50); +@@minLength(DeletedServiceContract.name, 1); +@@doc(DeletedServiceContract.name, "The name of the API Management service."); +@@doc(DeletedServiceContract.properties, + "Deleted API Management Service details." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/DiagnosticContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/DiagnosticContract.tsp new file mode 100644 index 000000000000..2b7a4e664ee8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/DiagnosticContract.tsp @@ -0,0 +1,711 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Diagnostic details. + */ +@parentResource(ApiContract) +model DiagnosticContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = DiagnosticContract, + KeyName = "diagnosticId", + SegmentName = "diagnostics", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface DiagnosticContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** API identifier. Must be unique in the current API Management service instance. */ + @path + @segment("apis") + @key + @minLength(1) + @maxLength(80) + apiId: string, + }, + { + /** Diagnostic identifier. Must be unique in the current API Management service instance. */ + @path + @segment("diagnostics") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + diagnosticId: string, + } + > {} + +@armResourceOperations +interface DiagnosticContracts { + /** + * Gets the details of the Diagnostic for an API specified by its identifier. + */ + get is DiagnosticContractOps.Read< + DiagnosticContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier. + */ + getEntityTag is DiagnosticContractOps.CheckExistence< + DiagnosticContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new Diagnostic for an API or updates an existing one. + */ + createOrUpdate is DiagnosticContractOps.CreateOrUpdateSync< + DiagnosticContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the Diagnostic for an API specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is DiagnosticContractOps.CustomPatchSync< + DiagnosticContract, + PatchModel = DiagnosticContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified Diagnostic from an API. + */ + delete is DiagnosticContractOps.DeleteSync< + DiagnosticContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all diagnostics of an API. + */ + listByService is DiagnosticContractOps.List< + DiagnosticContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @query("$skip") + @minValue(0) + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface DiagnosticOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** Diagnostic identifier. Must be unique in the current API Management service instance. */ + @path + @segment("diagnostics") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + diagnosticId: string, + } + > {} + +@armResourceOperations +interface Diagnostic { + /** + * Gets the details of the Diagnostic specified by its identifier. + */ + get is DiagnosticOps.Read< + DiagnosticContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Diagnostic specified by its identifier. + */ + getEntityTag is DiagnosticOps.CheckExistence< + DiagnosticContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new Diagnostic or updates an existing one. + */ + createOrUpdate is DiagnosticOps.CreateOrUpdateSync< + DiagnosticContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the Diagnostic specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is DiagnosticOps.CustomPatchSync< + DiagnosticContract, + PatchModel = DiagnosticContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified Diagnostic. + */ + delete is DiagnosticOps.DeleteSync< + DiagnosticContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all diagnostics of the API Management service instance. + */ + listByService is DiagnosticOps.List< + DiagnosticContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceDiagnosticOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** Diagnostic identifier. Must be unique in the current API Management service instance. */ + @path + @segment("diagnostics") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + diagnosticId: string, + } + > {} + +@armResourceOperations +interface WorkspaceDiagnostic { + /** + * Gets the details of the Diagnostic specified by its identifier. + */ + get is WorkspaceDiagnosticOps.Read< + DiagnosticContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Diagnostic specified by its identifier. + */ + getEntityTag is WorkspaceDiagnosticOps.CheckExistence< + DiagnosticContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new Diagnostic or updates an existing one. + */ + createOrUpdate is WorkspaceDiagnosticOps.CreateOrUpdateSync< + DiagnosticContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the Diagnostic specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is WorkspaceDiagnosticOps.CustomPatchSync< + DiagnosticContract, + PatchModel = DiagnosticUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified Diagnostic. + */ + delete is WorkspaceDiagnosticOps.DeleteSync< + DiagnosticContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all diagnostics in the specified workspace. + */ + listByWorkspace is WorkspaceDiagnosticOps.List< + DiagnosticContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceApiDiagnosticOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + + /** API identifier. Must be unique in the current API Management service instance. */ + @path + @segment("apis") + @key + @minLength(1) + @maxLength(80) + apiId: string, + }, + { + /** Diagnostic identifier. Must be unique in the current API Management service instance. */ + @path + @segment("diagnostics") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + diagnosticId: string, + } + > {} + +@armResourceOperations +interface WorkspaceApiDiagnostic { + /** + * Gets the details of the Diagnostic for an API specified by its identifier. + */ + get is WorkspaceApiDiagnosticOps.Read< + DiagnosticContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier. + */ + getEntityTag is WorkspaceApiDiagnosticOps.CheckExistence< + DiagnosticContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new Diagnostic for an API or updates an existing one. + */ + createOrUpdate is WorkspaceApiDiagnosticOps.CreateOrUpdateSync< + DiagnosticContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the Diagnostic for an API specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is WorkspaceApiDiagnosticOps.CustomPatchSync< + DiagnosticContract, + PatchModel = DiagnosticUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified Diagnostic from an API. + */ + delete is WorkspaceApiDiagnosticOps.DeleteSync< + DiagnosticContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all diagnostics of an API. + */ + listByWorkspace is WorkspaceApiDiagnosticOps.List< + DiagnosticContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(DiagnosticContract.name, 80); +@@minLength(DiagnosticContract.name, 1); +@@doc(DiagnosticContract.name, + "Diagnostic identifier. Must be unique in the current API Management service instance." +); +@@doc(DiagnosticContract.properties, "Diagnostic entity contract properties."); +@@doc(DiagnosticContracts.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(DiagnosticContracts.update::parameters.properties, + "Diagnostic Update parameters." +); +@@doc(Diagnostic.createOrUpdate::parameters.resource, "Create parameters."); +@@doc(Diagnostic.update::parameters.properties, + "Diagnostic Update parameters." +); +@@doc(WorkspaceDiagnostic.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(WorkspaceDiagnostic.update::parameters.properties, + "Diagnostic Update parameters." +); +@@doc(WorkspaceApiDiagnostic.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(WorkspaceApiDiagnostic.update::parameters.properties, + "Diagnostic Update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/DocumentationContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/DocumentationContract.tsp new file mode 100644 index 000000000000..16a37bcb0a3f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/DocumentationContract.tsp @@ -0,0 +1,166 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Markdown documentation details. + */ +@parentResource(ApiManagementServiceResource) +model DocumentationContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = DocumentationContract, + KeyName = "documentationId", + SegmentName = "documentations", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface DocumentationContracts { + /** + * Gets the details of the Documentation specified by its identifier. + */ + get is ArmResourceRead< + DocumentationContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Documentation by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + DocumentationContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new Documentation or updates an existing one. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + DocumentationContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the Documentation for an API specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + DocumentationContract, + PatchModel = DocumentationUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified Documentation from an API. + */ + delete is ArmResourceDeleteSync< + DocumentationContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all Documentations of the API Management service instance. + */ + listByService is ArmResourceListByParent< + DocumentationContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(DocumentationContract.name, 256); +@@minLength(DocumentationContract.name, 1); +@@doc(DocumentationContract.name, + "Documentation identifier. Must be unique in the current API Management service instance." +); +@@doc(DocumentationContract.properties, "Markdown Documentation details."); +@@doc(DocumentationContracts.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(DocumentationContracts.update::parameters.properties, + "Documentation Update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/EmailTemplateContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/EmailTemplateContract.tsp new file mode 100644 index 000000000000..2f2c6633bd3c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/EmailTemplateContract.tsp @@ -0,0 +1,180 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Email Template details. + */ +@parentResource(ApiManagementServiceResource) +model EmailTemplateContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = EmailTemplateContract, + KeyName = "templateName", + SegmentName = "templates", + NamePattern = "", + Type = TemplateName + >; +} + +@armResourceOperations +interface EmailTemplateContractsOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("templates") + @key + templateName: TemplateName, + } + > {} + +@armResourceOperations +interface EmailTemplateContracts { + /** + * Gets the details of the email template specified by its identifier. + */ + get is ArmResourceRead< + EmailTemplateContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the email template specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + EmailTemplateContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Updates an Email Template. + */ + createOrUpdate is EmailTemplateContractsOps.CreateOrUpdateSync< + EmailTemplateContract, + Request = EmailTemplateUpdateParameters, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + } + >; + + /** + * Updates API Management email template + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + EmailTemplateContract, + PatchModel = EmailTemplateUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Reset the Email Template to default template provided by the API Management service instance. + */ + delete is ArmResourceDeleteSync< + EmailTemplateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Gets all email templates + */ + listByService is ArmResourceListByParent< + EmailTemplateContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@doc(EmailTemplateContract.name, "Email Template Name Identifier."); +@@doc(EmailTemplateContract.properties, + "Email Template entity contract properties." +); +@@doc(EmailTemplateContracts.createOrUpdate::parameters.resource, + "Email Template update parameters." +); +@@doc(EmailTemplateContracts.update::parameters.properties, + "Update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GatewayCertificateAuthorityContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GatewayCertificateAuthorityContract.tsp new file mode 100644 index 000000000000..0ed4862ff318 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GatewayCertificateAuthorityContract.tsp @@ -0,0 +1,141 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./GatewayContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Gateway certificate authority details. + */ +@parentResource(GatewayContract) +model GatewayCertificateAuthorityContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = GatewayCertificateAuthorityContract, + KeyName = "certificateId", + SegmentName = "certificateAuthorities", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface GatewayCertificateAuthorityContracts { + /** + * Get assigned Gateway Certificate Authority details. + */ + get is ArmResourceRead< + GatewayCertificateAuthorityContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Checks if Certificate entity is assigned to Gateway entity as Certificate Authority. + */ + getEntityTag is ArmResourceCheckExistence< + GatewayCertificateAuthorityContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Assign Certificate entity to Gateway entity as Certificate Authority. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + GatewayCertificateAuthorityContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Remove relationship between Certificate Authority and Gateway entity. + */ + delete is ArmResourceDeleteSync< + GatewayCertificateAuthorityContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists the collection of Certificate Authorities for the specified Gateway entity. + */ + listByService is ArmResourceListByParent< + GatewayCertificateAuthorityContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq, ne | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(GatewayCertificateAuthorityContract.name, 80); +@@minLength(GatewayCertificateAuthorityContract.name, 1); +@@doc(GatewayCertificateAuthorityContract.name, + "Identifier of the certificate entity. Must be unique in the current API Management service instance." +); +@@doc(GatewayCertificateAuthorityContract.properties, + "Gateway certificate authority details." +); +@@doc(GatewayCertificateAuthorityContracts.createOrUpdate::parameters.resource, + "" +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GatewayContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GatewayContract.tsp new file mode 100644 index 000000000000..c56960c9e26a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GatewayContract.tsp @@ -0,0 +1,308 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Gateway details. + */ +@parentResource(ApiManagementServiceResource) +model GatewayContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = GatewayContract, + KeyName = "gatewayId", + SegmentName = "gateways", + NamePattern = "" + >; +} + +alias GatewayApiParameter = { + ...ResourceInstanceParameters; + + /** + * API identifier. Must be unique in the current API Management service instance. + */ + @maxLength(80) + @minLength(1) + @path + @segment("apis") + apiId: string; +}; + +@armResourceOperations +interface GatewayContracts { + /** + * Gets the details of the Gateway specified by its identifier. + */ + get is ArmResourceRead< + GatewayContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Gateway specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + GatewayContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates a Gateway to be used in Api Management instance. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + GatewayContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmResourceCreatedSyncResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the gateway specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + GatewayContract, + PatchModel = GatewayContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes specific Gateway. + */ + delete is ArmResourceDeleteSync< + GatewayContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of gateways registered with service instance. + */ + listByService is ArmResourceListByParent< + GatewayContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| region | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; + + /** + * Retrieves gateway keys. + */ + listKeys is ArmResourceActionSync< + GatewayContract, + void, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Regenerates specified gateway key invalidating any tokens created with it. + */ + regenerateKey is ArmResourceActionSync< + GatewayContract, + GatewayKeyRegenerationRequestContract, + NoContentResponse + >; + + /** + * Gets the Shared Access Authorization Token for the gateway. + */ + generateToken is ArmResourceActionSync< + GatewayContract, + GatewayTokenRequestContract, + ArmResponse + >; + + /** + * Action is invalidating all debug credentials issued for gateway. + */ + invalidateDebugCredentials is ArmResourceActionSync< + GatewayContract, + void, + NoContentResponse + >; + + /** + * Create new debug credentials for gateway. + */ + listDebugCredentials is ArmResourceActionSync< + GatewayContract, + GatewayListDebugCredentialsContract, + ArmResponse + >; + + /** + * Fetches trace collected by gateway. + */ + listTrace is ArmResourceActionSync< + GatewayContract, + GatewayListTraceContract, + ArmResponse + >; + + /** + * Lists a collection of the APIs associated with a gateway. + */ + @get + @action("apis") + @list + gatewayApiListByService is ArmResourceActionSync< + GatewayContract, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; + + /** + * Checks that API entity specified by identifier is associated with the Gateway entity. + */ + @head + gatewayApiGetEntityTag(...GatewayApiParameter): (OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") etag: string; + }) | ErrorResponse; + + /** + * Adds an API to the specified Gateway. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @put + gatewayApiCreateOrUpdate( + ...GatewayApiParameter, + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @body + body?: AssociationContract, + ): ArmResponse | ArmResourceCreatedSyncResponse | ErrorResponse; + + /** + * Deletes the specified API from the specified Gateway. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @delete + gatewayApiDelete( + ...GatewayApiParameter, + ): OkResponse | NoContentResponse | ErrorResponse; +} + +@@maxLength(GatewayContract.name, 80); +@@minLength(GatewayContract.name, 1); +@@doc(GatewayContract.name, + "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'" +); +@@doc(GatewayContract.properties, "Gateway details."); +@@doc(GatewayContracts.createOrUpdate::parameters.resource, ""); +@@doc(GatewayContracts.update::parameters.properties, ""); +@@doc(GatewayContracts.regenerateKey::parameters.body, ""); +@@doc(GatewayContracts.generateToken::parameters.body, ""); +@@doc(GatewayContracts.listDebugCredentials::parameters.body, + "List debug credentials properties." +); +@@doc(GatewayContracts.listTrace::parameters.body, "List trace properties."); +@@doc(GatewayContracts.gatewayApiCreateOrUpdate::parameters.body, ""); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GatewayHostnameConfigurationContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GatewayHostnameConfigurationContract.tsp new file mode 100644 index 000000000000..9b76deab5c72 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GatewayHostnameConfigurationContract.tsp @@ -0,0 +1,141 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./GatewayContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Gateway hostname configuration details. + */ +@parentResource(GatewayContract) +model GatewayHostnameConfigurationContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = GatewayHostnameConfigurationContract, + KeyName = "hcId", + SegmentName = "hostnameConfigurations", + NamePattern = "" + >; +} + +@armResourceOperations +interface GatewayHostnameConfigurationContracts { + /** + * Get details of a hostname configuration + */ + get is ArmResourceRead< + GatewayHostnameConfigurationContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Checks that hostname configuration entity specified by identifier exists for specified Gateway entity. + */ + getEntityTag is ArmResourceCheckExistence< + GatewayHostnameConfigurationContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates of updates hostname configuration for a Gateway. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + GatewayHostnameConfigurationContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes the specified hostname configuration from the specified Gateway. + */ + delete is ArmResourceDeleteSync< + GatewayHostnameConfigurationContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists the collection of hostname configurations for the specified gateway. + */ + listByService is ArmResourceListByParent< + GatewayHostnameConfigurationContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| hostname | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(GatewayHostnameConfigurationContract.name, 80); +@@minLength(GatewayHostnameConfigurationContract.name, 1); +@@doc(GatewayHostnameConfigurationContract.name, + "Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity." +); +@@doc(GatewayHostnameConfigurationContract.properties, + "Gateway hostname configuration details." +); +@@doc(GatewayHostnameConfigurationContracts.createOrUpdate::parameters.resource, + "" +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GlobalSchemaContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GlobalSchemaContract.tsp new file mode 100644 index 000000000000..d2ffb9ac3a33 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GlobalSchemaContract.tsp @@ -0,0 +1,319 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Global Schema Contract details. + */ +@parentResource(ApiManagementServiceResource) +model GlobalSchemaContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = GlobalSchemaContract, + KeyName = "schemaId", + SegmentName = "schemas", + NamePattern = "" + >; +} + +@armResourceOperations +interface GlobalSchemaContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** Schema id identifier. Must be unique in the current API Management service instance. */ + @path + @segment("schemas") + @key + @minLength(1) + @maxLength(80) + schemaId: string, + } + > {} + +@armResourceOperations +interface GlobalSchemaContracts { + /** + * Gets the details of the Schema specified by its identifier. + */ + get is GlobalSchemaContractOps.Read< + GlobalSchemaContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Schema specified by its identifier. + */ + getEntityTag is GlobalSchemaContractOps.CheckExistence< + GlobalSchemaContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates new or updates existing specified Schema of the API Management service instance. + */ + createOrUpdate is GlobalSchemaContractOps.CreateOrUpdateAsync< + GlobalSchemaContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & + ArmCombinedLroHeaders & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmResourceCreatedResponse< + GlobalSchemaContract, + LroHeaders = ArmCombinedLroHeaders + > & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes specific Schema. + */ + delete is GlobalSchemaContractOps.DeleteSync< + GlobalSchemaContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of schemas registered with service instance. + */ + listByService is GlobalSchemaContractOps.List< + GlobalSchemaContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceGlobalSchemaOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** Schema id identifier. Must be unique in the current API Management service instance. */ + @path + @segment("schemas") + @key + @minLength(1) + @maxLength(80) + schemaId: string, + } + > {} + +@armResourceOperations +interface WorkspaceGlobalSchema { + /** + * Gets the details of the Schema specified by its identifier. + */ + get is WorkspaceGlobalSchemaOps.Read< + GlobalSchemaContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Schema specified by its identifier. + */ + getEntityTag is WorkspaceGlobalSchemaOps.CheckExistence< + GlobalSchemaContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates new or updates existing specified Schema of the workspace in an API Management service instance. + */ + createOrUpdate is WorkspaceGlobalSchemaOps.CreateOrUpdateAsync< + GlobalSchemaContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & + ArmCombinedLroHeaders & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmResourceCreatedResponse< + GlobalSchemaContract, + LroHeaders = ArmCombinedLroHeaders + > & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes specific Schema. + */ + delete is WorkspaceGlobalSchemaOps.DeleteSync< + GlobalSchemaContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of schemas registered with workspace in a service instance. + */ + listByService is WorkspaceGlobalSchemaOps.List< + GlobalSchemaContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(GlobalSchemaContract.name, 80); +@@minLength(GlobalSchemaContract.name, 1); +@@doc(GlobalSchemaContract.name, + "Schema id identifier. Must be unique in the current API Management service instance." +); +@@doc(GlobalSchemaContract.properties, "Properties of the Global Schema."); +@@doc(GlobalSchemaContracts.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(WorkspaceGlobalSchema.createOrUpdate::parameters.resource, + "Create or update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GroupContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GroupContract.tsp new file mode 100644 index 000000000000..a3fa8f126c2b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/GroupContract.tsp @@ -0,0 +1,613 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Contract details. + */ +@parentResource(ApiManagementServiceResource) +model GroupContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = GroupContract, + KeyName = "groupId", + SegmentName = "groups", + NamePattern = "" + >; +} + +@armResourceOperations +interface GroupContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** Group identifier. Must be unique in the current API Management service instance. */ + @path + @segment("groups") + @key + @minLength(1) + @maxLength(256) + groupId: string, + } + > {} + +alias GroupUserParentParameters = { + ...ApiVersionParameter; + ...SubscriptionIdParameter; + ...ResourceGroupParameter; + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string; + + /** Group identifier. Must be unique in the current API Management service instance. */ + @path + @segment("groups") + @key + @minLength(1) + @maxLength(256) + groupId: string; +}; + +alias GroupUserParameters = { + /** + * User identifier. Must be unique in the current API Management service instance. + */ + @path + @segment("users") + @key + @minLength(1) + @maxLength(80) + userId: string; +}; + +alias GroupUserOps = Azure.ResourceManager.Legacy.RoutedOperations< + GroupUserParentParameters, + GroupUserParameters, + ResourceRoute = #{ + route: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users", + } +>; + +alias WorkspaceGroupUserParentParameters = { + ...ApiVersionParameter; + ...SubscriptionIdParameter; + ...ResourceGroupParameter; + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string; + + /** + * Workspace identifier. Must be unique in the current API Management service instance. + */ + @path + @key + @segment("workspaces") + @minLength(1) + @maxLength(80) + @pattern("^[^*#&+:<>?]+$") + workspaceId: string; + + /** Group identifier. Must be unique in the current API Management service instance. */ + @path + @segment("groups") + @key + @minLength(1) + @maxLength(256) + groupId: string; +}; + +alias WorkspaceGroupUserParameters = { + /** + * User identifier. Must be unique in the current API Management service instance. + */ + @path + @key + @segment("users") + @minLength(1) + @maxLength(80) + userId: string; +}; + +alias WorkspaceGroupUserOps = Azure.ResourceManager.Legacy.RoutedOperations< + WorkspaceGroupUserParentParameters, + WorkspaceGroupUserParameters, + ResourceRoute = #{ + route: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users", + } +>; + +@armResourceOperations(#{ allowStaticRoutes: true }) +interface GroupContracts { + /** + * Gets the details of the group specified by its identifier. + */ + get is GroupContractOps.Read< + GroupContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the group specified by its identifier. + */ + getEntityTag is GroupContractOps.CheckExistence< + GroupContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or Updates a group. + */ + createOrUpdate is GroupContractOps.CreateOrUpdateSync< + GroupContract, + Request = GroupCreateParameters, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the group specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is GroupContractOps.CustomPatchSync< + GroupContract, + PatchModel = GroupUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes specific group of the API Management service instance. + */ + delete is GroupContractOps.DeleteSync< + GroupContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of groups defined within a service instance. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-groups") + listByService is GroupContractOps.List< + GroupContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| externalId | filter | eq | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; + + /** + * Lists a collection of user entities associated with the group. + */ + @get + @action("users") + @list + list is GroupContractOps.ActionSync< + GroupContract, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; + + /** + * Checks that user entity specified by identifier is associated with the group entity. + */ + @head + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}") + checkEntityExists is GroupUserOps.ActionSync< + GroupContract, + void, + Response = NoContentResponse | NotFoundResponse + >; + + /** + * Add existing user to existing group + */ + @put + create is GroupContractOps.CreateOrUpdateSync< + GroupContract, + Request = void, + Response = ArmResponse | ArmResourceCreatedSyncResponse, + Parameters = { + /** + * User identifier. Must be unique in the current API Management service instance. + */ + @maxLength(80) + @minLength(1) + @path + @segment("users") + userId: string; + } + >; + + /** + * Remove existing user from existing group. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @delete + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}") + groupUserDelete is GroupUserOps.ActionSync< + GroupContract, + void, + Response = OkResponse | NoContentResponse + >; +} +@armResourceOperations +interface WorkspaceGroupOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** Group identifier. Must be unique in the current API Management service instance. */ + @path + @segment("groups") + @key + @minLength(1) + @maxLength(256) + groupId: string, + } + > {} + +@armResourceOperations(#{ allowStaticRoutes: true }) +interface WorkspaceGroup { + /** + * Gets the details of the group specified by its identifier. + */ + get is WorkspaceGroupOps.Read< + GroupContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the group specified by its identifier. + */ + getEntityTag is WorkspaceGroupOps.CheckExistence< + GroupContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or Updates a group. + */ + createOrUpdate is WorkspaceGroupOps.CreateOrUpdateSync< + GroupContract, + Request = GroupCreateParameters, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmResourceCreatedSyncResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the group specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is WorkspaceGroupOps.CustomPatchSync< + GroupContract, + PatchModel = GroupUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes specific group of the workspace in an API Management service instance. + */ + delete is WorkspaceGroupOps.DeleteSync< + GroupContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of groups defined within a workspace in a service instance. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-groups") + listByService is WorkspaceGroupOps.List< + GroupContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| externalId | filter | eq | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; + + /** + * Lists a collection of user entities associated with the group. + */ + @get + @action("users") + @list + list is WorkspaceGroupOps.ActionSync< + GroupContract, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; + + /** + * Checks that user entity specified by identifier is associated with the group entity. + */ + @head + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users/{userId}") + checkEntityExists is WorkspaceGroupUserOps.ActionSync< + GroupContract, + void, + Response = NoContentResponse | NotFoundResponse + >; + + /** + * Add existing user to existing group + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation-response" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @put + create is WorkspaceGroupOps.CreateOrUpdateSync< + GroupContract, + Request = void, + Response = ArmResponse | ArmResourceCreatedSyncResponse, + Parameters = { + /** + * User identifier. Must be unique in the current API Management service instance. + */ + @maxLength(80) + @minLength(1) + @path + @segment("users") + userId: string; + } + >; + + /** + * Remove existing user from existing group. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @delete + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users/{userId}") + workspaceGroupUserDelete is WorkspaceGroupUserOps.ActionSync< + GroupContract, + void, + Response = OkResponse | NoContentResponse + >; +} + +@@maxLength(GroupContract.name, 256); +@@minLength(GroupContract.name, 1); +@@doc(GroupContract.name, + "Group identifier. Must be unique in the current API Management service instance." +); +@@doc(GroupContract.properties, "Group entity contract properties."); +@@doc(GroupContracts.createOrUpdate::parameters.resource, "Create parameters."); +@@doc(GroupContracts.update::parameters.properties, "Update parameters."); +@@doc(WorkspaceGroup.createOrUpdate::parameters.resource, "Create parameters."); +@@doc(WorkspaceGroup.update::parameters.properties, "Update parameters."); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/IdentityProviderContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/IdentityProviderContract.tsp new file mode 100644 index 000000000000..72fc1dd1162a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/IdentityProviderContract.tsp @@ -0,0 +1,189 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Identity Provider details. + */ +@parentResource(ApiManagementServiceResource) +model IdentityProviderContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = IdentityProviderContract, + KeyName = "identityProviderName", + SegmentName = "identityProviders", + NamePattern = "", + Type = IdentityProviderType + >; +} + +@armResourceOperations +interface IdentityProviderContractsOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** Identity Provider Type identifier. */ + @path + @segment("identityProviders") + @key + identityProviderName: IdentityProviderType, + } + > {} + +@armResourceOperations +interface IdentityProviderContracts { + /** + * Gets the configuration details of the identity Provider configured in specified service instance. + */ + get is ArmResourceRead< + IdentityProviderContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag?: string; + } + >; + + /** + * Gets the entity state (Etag) version of the identityProvider specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + IdentityProviderContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag?: string; + } + >; + + /** + * Creates or Updates the IdentityProvider configuration. + */ + createOrUpdate is IdentityProviderContractsOps.CreateOrUpdateSync< + IdentityProviderContract, + Request = IdentityProviderCreateContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag?: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag?: string; + }) + >; + + /** + * Updates an existing IdentityProvider configuration. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + IdentityProviderContract, + PatchModel = IdentityProviderUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag?: string; + } + >; + + /** + * Deletes the specified identity provider configuration. + */ + delete is ArmResourceDeleteSync< + IdentityProviderContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of Identity Provider configured in the specified service instance. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-aad#how-to-authorize-developer-accounts-using-azure-active-directory") + listByService is ArmResourceListByParent< + IdentityProviderContract, + Response = ArmResponse + >; + + /** + * Gets the client secret details of the Identity Provider. + */ + listSecrets is ArmResourceActionSync< + IdentityProviderContract, + void, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag?: string; + } + >; +} + +@@doc(IdentityProviderContract.name, "Identity Provider Type identifier."); +@@doc(IdentityProviderContract.properties, + "Identity Provider contract properties." +); +@@doc(IdentityProviderContracts.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(IdentityProviderContracts.update::parameters.properties, + "Update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/IssueAttachmentContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/IssueAttachmentContract.tsp new file mode 100644 index 000000000000..a5cb1983ef6c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/IssueAttachmentContract.tsp @@ -0,0 +1,141 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./IssueContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Issue Attachment Contract details. + */ +@parentResource(IssueContract) +model IssueAttachmentContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = IssueAttachmentContract, + KeyName = "attachmentId", + SegmentName = "attachments", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface IssueAttachmentContracts { + /** + * Gets the details of the issue Attachment for an API specified by its identifier. + */ + get is ArmResourceRead< + IssueAttachmentContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + IssueAttachmentContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new Attachment for the Issue in an API or updates an existing one. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + IssueAttachmentContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes the specified comment from an Issue. + */ + delete is ArmResourceDeleteSync< + IssueAttachmentContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all attachments for the Issue associated with the specified API. + */ + listByService is ArmResourceListByParent< + IssueAttachmentContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @query("$skip") + @minValue(0) + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(IssueAttachmentContract.name, 256); +@@minLength(IssueAttachmentContract.name, 1); +@@doc(IssueAttachmentContract.name, + "Attachment identifier within an Issue. Must be unique in the current Issue." +); +@@doc(IssueAttachmentContract.properties, + "Properties of the Issue Attachment." +); +@@doc(IssueAttachmentContracts.createOrUpdate::parameters.resource, + "Create parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/IssueCommentContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/IssueCommentContract.tsp new file mode 100644 index 000000000000..5b14592478f8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/IssueCommentContract.tsp @@ -0,0 +1,139 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./IssueContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Issue Comment Contract details. + */ +@parentResource(IssueContract) +model IssueCommentContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = IssueCommentContract, + KeyName = "commentId", + SegmentName = "comments", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface IssueCommentContracts { + /** + * Gets the details of the issue Comment for an API specified by its identifier. + */ + get is ArmResourceRead< + IssueCommentContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + IssueCommentContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new Comment for the Issue in an API or updates an existing one. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + IssueCommentContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes the specified comment from an Issue. + */ + delete is ArmResourceDeleteSync< + IssueCommentContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all comments for the Issue associated with the specified API. + */ + listByService is ArmResourceListByParent< + IssueCommentContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(IssueCommentContract.name, 256); +@@minLength(IssueCommentContract.name, 1); +@@doc(IssueCommentContract.name, + "Comment identifier within an Issue. Must be unique in the current Issue." +); +@@doc(IssueCommentContract.properties, "Properties of the Issue Comment."); +@@doc(IssueCommentContracts.createOrUpdate::parameters.resource, + "Create parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/IssueContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/IssueContract.tsp new file mode 100644 index 000000000000..10c0e378de87 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/IssueContract.tsp @@ -0,0 +1,288 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Issue Contract details. + */ +@parentResource(ApiContract) +model IssueContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = IssueContract, + KeyName = "issueId", + SegmentName = "issues", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface IssueContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** API identifier. Must be unique in the current API Management service instance. */ + @path + @segment("apis") + @key + @minLength(1) + @maxLength(80) + apiId: string, + }, + { + /** Issue identifier. Must be unique in the current API Management service instance. */ + @path + @segment("issues") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + issueId: string, + } + > {} + +@armResourceOperations +interface IssueContracts { + /** + * Gets the details of the Issue for an API specified by its identifier. + */ + get is IssueContractOps.Read< + IssueContract, + Parameters = { + /** + * Expand the comment attachments. + */ + @query("expandCommentsAttachments") + expandCommentsAttachments?: boolean; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Issue for an API specified by its identifier. + */ + getEntityTag is IssueContractOps.CheckExistence< + IssueContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new Issue for an API or updates an existing one. + */ + createOrUpdate is IssueContractOps.CreateOrUpdateSync< + IssueContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates an existing issue for an API. + */ + @patch(#{ implicitOptionality: false }) + update is IssueContractOps.CustomPatchSync< + IssueContract, + PatchModel = IssueUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified Issue from an API. + */ + delete is IssueContractOps.DeleteSync< + IssueContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all issues associated with the specified API. + */ + listByService is IssueContractOps.List< + IssueContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Expand the comment attachments. + */ + @query("expandCommentsAttachments") + expandCommentsAttachments?: boolean; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @query("$skip") + @minValue(0) + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface IssueOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** Issue identifier. Must be unique in the current API Management service instance. */ + @path + @segment("issues") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + issueId: string, + } + > {} + +@armResourceOperations +interface Issue { + /** + * Gets API Management issue details + */ + get is IssueOps.Read< + IssueContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag?: string; + } + >; + + /** + * Lists a collection of issues in the specified service instance. + */ + listByService is IssueOps.List< + IssueContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| authorName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(IssueContract.name, 256); +@@minLength(IssueContract.name, 1); +@@doc(IssueContract.name, + "Issue identifier. Must be unique in the current API Management service instance." +); +@@doc(IssueContract.properties, "Properties of the Issue."); +@@doc(IssueContracts.createOrUpdate::parameters.resource, "Create parameters."); +@@doc(IssueContracts.update::parameters.properties, "Update parameters."); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/LoggerContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/LoggerContract.tsp new file mode 100644 index 000000000000..61fd565293fd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/LoggerContract.tsp @@ -0,0 +1,364 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Logger details. + */ +@parentResource(ApiManagementServiceResource) +model LoggerContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = LoggerContract, + KeyName = "loggerId", + SegmentName = "loggers", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface LoggerContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** Logger identifier. Must be unique in the API Management service instance. */ + @path + @segment("loggers") + @key + @pattern("^[^*#&+:<>?]+$") + @maxLength(256) + loggerId: string, + } + > {} + +@armResourceOperations +interface LoggerContracts { + /** + * Gets the details of the logger specified by its identifier. + */ + get is LoggerContractOps.Read< + LoggerContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag?: string; + } + >; + + /** + * Gets the entity state (Etag) version of the logger specified by its identifier. + */ + getEntityTag is LoggerContractOps.CheckExistence< + LoggerContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag?: string; + } + >; + + /** + * Creates or Updates a logger. + */ + createOrUpdate is LoggerContractOps.CreateOrUpdateSync< + LoggerContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag?: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag?: string; + }) + >; + + /** + * Updates an existing logger. + */ + @patch(#{ implicitOptionality: false }) + update is LoggerContractOps.CustomPatchSync< + LoggerContract, + PatchModel = LoggerUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag?: string; + } + >; + + /** + * Deletes the specified logger. + */ + delete is LoggerContractOps.DeleteSync< + LoggerContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of loggers in the specified service instance. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-log-event-hubs") + listByService is LoggerContractOps.List< + LoggerContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| loggerType | filter | eq | |
| resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceLoggerOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** Logger identifier. Must be unique in the API Management service instance. */ + @path + @segment("loggers") + @key + @pattern("^[^*#&+:<>?]+$") + @maxLength(256) + loggerId: string, + } + > {} + +@armResourceOperations +interface WorkspaceLogger { + /** + * Gets the details of the logger specified by its identifier. + */ + get is WorkspaceLoggerOps.Read< + LoggerContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the logger specified by its identifier. + */ + getEntityTag is WorkspaceLoggerOps.CheckExistence< + LoggerContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or Updates a logger. + */ + createOrUpdate is WorkspaceLoggerOps.CreateOrUpdateSync< + LoggerContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates an existing logger. + */ + @patch(#{ implicitOptionality: false }) + update is WorkspaceLoggerOps.CustomPatchSync< + LoggerContract, + PatchModel = LoggerUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified logger. + */ + delete is WorkspaceLoggerOps.DeleteSync< + LoggerContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of loggers in the specified workspace. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-log-event-hubs") + listByWorkspace is WorkspaceLoggerOps.List< + LoggerContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| loggerType | filter | eq | |
| resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(LoggerContract.name, 256); +@@doc(LoggerContract.name, + "Logger identifier. Must be unique in the API Management service instance." +); +@@doc(LoggerContract.properties, "Logger entity contract properties."); +@@doc(LoggerContracts.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(LoggerContracts.update::parameters.properties, "Update parameters."); +@@doc(WorkspaceLogger.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(WorkspaceLogger.update::parameters.properties, "Update parameters."); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/NamedValueContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/NamedValueContract.tsp new file mode 100644 index 000000000000..a1a458e72017 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/NamedValueContract.tsp @@ -0,0 +1,444 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * NamedValue details. + */ +@parentResource(ApiManagementServiceResource) +model NamedValueContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = NamedValueContract, + KeyName = "namedValueId", + SegmentName = "namedValues", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface NamedValueContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** Identifier of the NamedValue. */ + @path + @segment("namedValues") + @key + @pattern("^[^*#&+:<>?]+$") + @maxLength(256) + namedValueId: string, + } + > {} + +@armResourceOperations +interface NamedValueContracts { + /** + * Gets the details of the named value specified by its identifier. + */ + get is NamedValueContractOps.Read< + NamedValueContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag?: string; + } + >; + + /** + * Gets the entity state (Etag) version of the named value specified by its identifier. + */ + getEntityTag is NamedValueContractOps.CheckExistence< + NamedValueContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag?: string; + } + >; + + /** + * Creates or updates named value. + */ + createOrUpdate is NamedValueContractOps.CreateOrUpdateAsync< + NamedValueContract, + Request = NamedValueCreateContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & + ArmCombinedLroHeaders & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmResourceCreatedResponse< + NamedValueContract, + LroHeaders = ArmCombinedLroHeaders + > & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the specific named value. + */ + @patch(#{ implicitOptionality: false }) + update is NamedValueContractOps.CustomPatchAsync< + NamedValueContract, + PatchModel = NamedValueUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | ArmAcceptedLroResponse> + >; + + /** + * Deletes specific named value from the API Management service instance. + */ + delete is NamedValueContractOps.DeleteSync< + NamedValueContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of named values defined within a service instance. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties") + listByService is NamedValueContractOps.List< + NamedValueContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * When set to true, the response contains only named value entities which failed refresh. + */ + @query("isKeyVaultRefreshFailed") + isKeyVaultRefreshFailed?: boolean; + }, + Response = ArmResponse + >; + + /** + * Gets the secret of the named value specified by its identifier. + */ + listValue is NamedValueContractOps.ActionSync< + NamedValueContract, + void, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Refresh the secret of the named value specified by its identifier. + */ + refreshSecret is NamedValueContractOps.ActionAsync< + NamedValueContract, + Request = void, + Result = void, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | ArmAcceptedLroResponse> + >; +} +@armResourceOperations +interface WorkspaceNamedValueOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** Identifier of the NamedValue. */ + @path + @segment("namedValues") + @key + @pattern("^[^*#&+:<>?]+$") + @maxLength(256) + namedValueId: string, + } + > {} + +@armResourceOperations +interface WorkspaceNamedValue { + /** + * Gets the details of the named value specified by its identifier. + */ + get is WorkspaceNamedValueOps.Read< + NamedValueContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the named value specified by its identifier. + */ + getEntityTag is WorkspaceNamedValueOps.CheckExistence< + NamedValueContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates named value. + */ + createOrUpdate is WorkspaceNamedValueOps.CreateOrUpdateAsync< + NamedValueContract, + Request = NamedValueCreateContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & + ArmCombinedLroHeaders & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmResourceCreatedResponse & + ArmCombinedLroHeaders & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the specific named value. + */ + @patch(#{ implicitOptionality: false }) + update is WorkspaceNamedValueOps.CustomPatchAsync< + NamedValueContract, + PatchModel = NamedValueUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | ArmAcceptedLroResponse> + >; + + /** + * Deletes specific named value from the workspace in an API Management service instance. + */ + delete is WorkspaceNamedValueOps.DeleteSync< + NamedValueContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of named values defined within a workspace in a service instance. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @externalDocs("https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties") + listByService is WorkspaceNamedValueOps.List< + NamedValueContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * Query parameter to fetch named value entities based on refresh status. + */ + @query("isKeyVaultRefreshFailed") + isKeyVaultRefreshFailed?: KeyVaultRefreshState; + }, + Response = ArmResponse + >; + + /** + * Gets the secret of the named value specified by its identifier. + */ + listValue is WorkspaceNamedValueOps.ActionSync< + NamedValueContract, + void, + ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Refresh the secret of the named value specified by its identifier. + */ + refreshSecret is WorkspaceNamedValueOps.ActionAsync< + NamedValueContract, + Request = void, + Result = void, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | ArmAcceptedLroResponse> + >; +} + +@@maxLength(NamedValueContract.name, 256); +@@doc(NamedValueContract.name, "Identifier of the NamedValue."); +@@doc(NamedValueContract.properties, "NamedValue entity contract properties."); +@@doc(NamedValueContracts.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(NamedValueContracts.update::parameters.properties, "Update parameters."); +@@doc(WorkspaceNamedValue.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(WorkspaceNamedValue.update::parameters.properties, "Update parameters."); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/NotificationContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/NotificationContract.tsp new file mode 100644 index 000000000000..d6fb5a11eac0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/NotificationContract.tsp @@ -0,0 +1,546 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Notification details. + */ +@parentResource(ApiManagementServiceResource) +model NotificationContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = NotificationContract, + KeyName = "notificationName", + SegmentName = "notifications", + NamePattern = "", + Type = NotificationName + >; +} + +alias NotificationRecipientEmailParentParameters = { + ...ApiVersionParameter; + ...SubscriptionIdParameter; + ...ResourceGroupParameter; + + /** + * The name of the API Management service. + */ + @path + @segment("service") + @key + @minLength(1) + @maxLength(50) + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + serviceName: string; + + /** + * Notification Name Identifier. + */ + @segment("notifications") + notificationName: NotificationName; +}; + +alias NotificationRecipientEmailParameters = { + /** + * Email identifier. + */ + @path + @segment("recipientEmails") + email: string; +}; + +alias NotificationRecipientEmailOps = Azure.ResourceManager.Legacy.RoutedOperations< + NotificationRecipientEmailParentParameters, + NotificationRecipientEmailParameters, + ResourceRoute = #{ + route: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}", + } +>; + +alias NotificationRecipientUserParentParameters = { + ...ApiVersionParameter; + ...SubscriptionIdParameter; + ...ResourceGroupParameter; + + /** + * The name of the API Management service. + */ + @path + @segment("service") + @key + @minLength(1) + @maxLength(50) + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + serviceName: string; + + /** + * Notification Name Identifier. + */ + @segment("notifications") + notificationName: NotificationName; +}; + +alias NotificationRecipientUserParameters = { + /** + * User identifier. Must be unique in the current API Management service instance. + */ + @maxLength(80) + @minLength(1) + @path + @segment("recipientUsers") + userId: string; +}; + +alias NotificationRecipientUserOps = Azure.ResourceManager.Legacy.RoutedOperations< + NotificationRecipientUserParentParameters, + NotificationRecipientUserParameters, + ResourceRoute = #{ + route: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers", + } +>; + +alias WorkspaceNotificationRecipientUserParameters = { + ...ApiVersionParameter; + ...SubscriptionIdParameter; + ...ResourceGroupParameter; + ...Azure.ResourceManager.Legacy.Provider; + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string; + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string; + + /** + * Workspace identifier. Must be unique in the current API Management service instance. + */ + @path + @segment("notifications") + @key + notificationName: NotificationName; + + /** + * User identifier. Must be unique in the current API Management service instance. + */ + @maxLength(80) + @minLength(1) + @path + @segment("recipientUsers") + userId: string; +}; + +alias WorkspaceNotificationRecipientEmailParameters = { + ...ApiVersionParameter; + ...SubscriptionIdParameter; + ...ResourceGroupParameter; + ...Azure.ResourceManager.Legacy.Provider; + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string; + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string; + + /** + * Workspace identifier. Must be unique in the current API Management service instance. + */ + @path + @segment("notifications") + @key + notificationName: NotificationName; + + /** + * Email identifier. + */ + @path + @segment("recipientEmails") + email: string; +}; + +@armResourceOperations +interface NotificationContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** Notification Name Identifier. */ + @path + @segment("notifications") + @key + notificationName: NotificationName, + } + > {} + +@armResourceOperations(#{ allowStaticRoutes: true }) +interface NotificationContracts { + /** + * Gets the details of the Notification specified by its identifier. + */ + get is NotificationContractOps.Read; + + // FIXME: (ArmResourceCreateOrReplace): ArmResourceCreateOrReplaceAsync/ArmResourceCreateOrReplaceSync should have a body parameter. + /** + * Create or Update API Management publisher notification. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + createOrUpdate is NotificationContractOps.CreateOrUpdateSync< + NotificationContract, + Request = void, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = ArmResourceUpdatedResponse + >; + + /** + * Lists a collection of properties defined within a service instance. + */ + listByService is NotificationContractOps.List< + NotificationContract, + Parameters = { + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; + + /** + * Gets the list of the Notification Recipient User subscribed to the notification. + */ + @get + @action("recipientUsers") + listByNotification is NotificationContractOps.ActionSync< + NotificationContract, + void, + ArmResponse + >; + + /** + * Determine if the Notification Recipient User is subscribed to the notification. + */ + @head + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers/{userId}") + checkEntityExists is NotificationRecipientUserOps.ActionSync< + NotificationContract, + void, + Response = NoContentResponse | NotFoundResponse + >; + + /** + * Adds the API Management User to the list of Recipients for the Notification. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @put + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers/{userId}") + notificationRecipientUserCreateOrUpdate is NotificationRecipientUserOps.ActionSync< + NotificationContract, + void, + Response = ArmResponse | ArmResourceCreatedSyncResponse + >; + + /** + * Removes the API Management user from the list of Notification. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @delete + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers/{userId}") + delete is NotificationRecipientUserOps.ActionSync< + NotificationContract, + void, + Response = OkResponse | NoContentResponse | ErrorResponse + >; + + /** + * Gets the list of the Notification Recipient Emails subscribed to a notification. + */ + @get + @action("recipientEmails") + notificationRecipientEmailListByNotification is NotificationContractOps.ActionSync< + NotificationContract, + void, + ArmResponse + >; + + /** + * Determine if Notification Recipient Email subscribed to the notification. + */ + @head + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}") + notificationRecipientEmailCheckEntityExists is NotificationRecipientEmailOps.ActionSync< + NotificationContract, + void, + Response = NoContentResponse | NotFoundResponse + >; + + /** + * Adds the Email address to the list of Recipients for the Notification. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @put + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}") + notificationRecipientEmailCreateOrUpdate is NotificationRecipientEmailOps.ActionSync< + NotificationContract, + void, + Response = ArmResponse | ArmResourceCreatedSyncResponse + >; + + /** + * Removes the email from the list of Notification. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @delete + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}") + notificationRecipientEmailDelete is NotificationRecipientEmailOps.ActionSync< + NotificationContract, + void, + Response = OkResponse | NoContentResponse + >; +} +@armResourceOperations +interface WorkspaceNotificationOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** Notification Name Identifier. */ + @path + @segment("notifications") + @key + notificationName: NotificationName, + } + > {} + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations +interface WorkspaceNotification { + /** + * Gets the details of the Notification specified by its identifier. + */ + get is WorkspaceNotificationOps.Read; + + // FIXME: (ArmResourceCreateOrReplace): ArmResourceCreateOrReplaceAsync/ArmResourceCreateOrReplaceSync should have a body parameter. + /** + * Create or Update API Management publisher notification for the workspace. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + createOrUpdate is WorkspaceNotificationOps.CreateOrUpdateSync< + NotificationContract, + Request = void, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = ArmResourceUpdatedResponse + >; + + /** + * Lists a collection of properties defined within a service instance. + */ + listByService is WorkspaceNotificationOps.List< + NotificationContract, + Parameters = { + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; + + /** + * Gets the list of the Notification Recipient User subscribed to the notification. + */ + @get + @action("recipientUsers") + listByNotification is WorkspaceNotificationOps.ActionSync< + NotificationContract, + void, + ArmResponse + >; + + /** + * Determine if the Notification Recipient User is subscribed to the notification. + */ + @head + checkEntityExists( + ...WorkspaceNotificationRecipientUserParameters, + ): NoContentResponse | NotFoundResponse | ErrorResponse; + + /** + * Adds the API Management User to the list of Recipients for the Notification. + */ + @put + workspaceNotificationRecipientUserCreateOrUpdate is WorkspaceNotificationOps.CreateOrUpdateSync< + NotificationContract, + Request = void, + Response = ArmResponse | ArmResourceCreatedSyncResponse, + Parameters = { + /** + * User identifier. Must be unique in the current API Management service instance. + */ + @maxLength(80) + @minLength(1) + @path + @segment("recipientUsers") + userId: string; + } + >; + + /** + * Removes the API Management user from the list of Notification. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @delete + delete( + ...WorkspaceNotificationRecipientUserParameters, + ): OkResponse | NoContentResponse | ErrorResponse; + + /** + * Gets the list of the Notification Recipient Emails subscribed to a notification. + */ + @get + @action("recipientEmails") + workspaceNotificationRecipientEmailListByNotification is WorkspaceNotificationOps.ActionSync< + NotificationContract, + void, + ArmResponse + >; + + /** + * Determine if Notification Recipient Email subscribed to the notification. + */ + @head + workspaceNotificationRecipientEmailCheckEntityExists( + ...WorkspaceNotificationRecipientEmailParameters, + ): NoContentResponse | NotFoundResponse | ErrorResponse; + + /** + * Adds the Email address to the list of Recipients for the Notification. + */ + @put + workspaceNotificationRecipientEmailCreateOrUpdate is WorkspaceNotificationOps.CreateOrUpdateSync< + NotificationContract, + Request = void, + Response = ArmResponse | ArmResourceCreatedSyncResponse, + Parameters = { + /** + * Email identifier. + */ + @path + @segment("recipientEmails") + email: string; + } + >; + + /** + * Removes the email from the list of Notification. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @delete + workspaceNotificationRecipientEmailDelete( + ...WorkspaceNotificationRecipientEmailParameters, + ): OkResponse | NoContentResponse | ErrorResponse; +} + +@@doc(NotificationContract.name, "Notification Name Identifier."); +@@doc(NotificationContract.properties, + "Notification entity contract properties." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/OpenidConnectProviderContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/OpenidConnectProviderContract.tsp new file mode 100644 index 000000000000..8344dadb5586 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/OpenidConnectProviderContract.tsp @@ -0,0 +1,182 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * OpenId Connect Provider details. + */ +@parentResource(ApiManagementServiceResource) +model OpenidConnectProviderContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = OpenidConnectProviderContract, + KeyName = "opid", + SegmentName = "openidConnectProviders", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface OpenidConnectProviderContracts { + /** + * Gets specific OpenID Connect Provider without secrets. + */ + get is ArmResourceRead< + OpenidConnectProviderContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + OpenidConnectProviderContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates the OpenID Connect Provider. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + OpenidConnectProviderContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the specific OpenID Connect Provider. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + OpenidConnectProviderContract, + PatchModel = OpenidConnectProviderUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes specific OpenID Connect Provider of the API Management service instance. + */ + delete is ArmResourceDeleteSync< + OpenidConnectProviderContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists of all the OpenId Connect Providers. + */ + listByService is ArmResourceListByParent< + OpenidConnectProviderContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; + + /** + * Gets the client secret details of the OpenID Connect Provider. + */ + listSecrets is ArmResourceActionSync< + OpenidConnectProviderContract, + void, + ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; +} + +@@maxLength(OpenidConnectProviderContract.name, 256); +@@doc(OpenidConnectProviderContract.name, + "Identifier of the OpenID Connect Provider." +); +@@doc(OpenidConnectProviderContract.properties, + "OpenId Connect Provider contract properties." +); +@@doc(OpenidConnectProviderContracts.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(OpenidConnectProviderContracts.update::parameters.properties, + "Update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/OperationContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/OperationContract.tsp new file mode 100644 index 000000000000..c79c4aec5f43 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/OperationContract.tsp @@ -0,0 +1,395 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * API Operation details. + */ +@parentResource(ApiContract) +model OperationContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = OperationContract, + KeyName = "operationId", + SegmentName = "operations", + NamePattern = "" + >; +} + +@armResourceOperations +interface OperationContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("apis") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + apiId: string, + }, + { + /** Operation identifier within an API. Must be unique in the current API Management service instance. */ + @path + @segment("operations") + @key + @minLength(1) + @maxLength(80) + operationId: string, + } + > {} + +@armResourceOperations +interface OperationContracts { + /** + * Gets the details of the API Operation specified by its identifier. + */ + get is OperationContractOps.Read< + OperationContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the API operation specified by its identifier. + */ + getEntityTag is OperationContractOps.CheckExistence< + OperationContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new operation in the API or updates an existing one. + */ + createOrUpdate is OperationContractOps.CreateOrUpdateSync< + OperationContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the operation in the API specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is OperationContractOps.CustomPatchSync< + OperationContract, + PatchModel = OperationUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified operation in the API. + */ + delete is OperationContractOps.DeleteSync< + OperationContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of the operations for the specified API. + */ + listByApi is OperationContractOps.List< + OperationContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * Include tags in the response. + */ + @query("tags") + tags?: string; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceApiOperationOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("apis") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + apiId: string, + }, + { + /** Operation identifier within an API. Must be unique in the current API Management service instance. */ + @path + @segment("operations") + @key + @minLength(1) + @maxLength(80) + operationId: string, + } + > {} + +@armResourceOperations +interface WorkspaceApiOperation { + /** + * Gets the details of the API Operation specified by its identifier. + */ + get is WorkspaceApiOperationOps.Read< + OperationContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the API operation specified by its identifier. + */ + getEntityTag is WorkspaceApiOperationOps.CheckExistence< + OperationContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new operation in the API or updates an existing one. + */ + createOrUpdate is WorkspaceApiOperationOps.CreateOrUpdateSync< + OperationContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the operation in the API specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is WorkspaceApiOperationOps.CustomPatchSync< + OperationContract, + PatchModel = OperationUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified operation in the API. + */ + delete is WorkspaceApiOperationOps.DeleteSync< + OperationContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of the operations for the specified API. + */ + listByApi is WorkspaceApiOperationOps.List< + OperationContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * Include tags in the response. + */ + @query("tags") + tags?: string; + }, + Response = ArmResponse + >; +} + +@@maxLength(OperationContract.name, 80); +@@minLength(OperationContract.name, 1); +@@doc(OperationContract.name, + "Operation identifier within an API. Must be unique in the current API Management service instance." +); +@@doc(OperationContract.properties, "Properties of the Operation Contract."); +@@doc(OperationContracts.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(OperationContracts.update::parameters.properties, + "API Operation Update parameters." +); +@@doc(WorkspaceApiOperation.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(WorkspaceApiOperation.update::parameters.properties, + "API Operation Update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PolicyContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PolicyContract.tsp new file mode 100644 index 000000000000..ba6171d40db2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PolicyContract.tsp @@ -0,0 +1,1216 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./OperationContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Policy Contract details. + */ +@parentResource(OperationContract) +model PolicyContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = PolicyContract, + KeyName = "policyId", + SegmentName = "policies", + NamePattern = "", + Type = PolicyIdName + >; +} + +@armResourceOperations +interface PolicyContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("apis") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + apiId: string, + + /** Operation identifier within an API. Must be unique in the current API Management service instance. */ + @path + @segment("operations") + @key + @minLength(1) + @maxLength(80) + operationId: string, + }, + { + /** The identifier of the Policy. */ + @path + @segment("policies") + @key + policyId: PolicyIdName, + } + > {} + +@armResourceOperations +interface PolicyContracts { + /** + * Get the policy configuration at the API Operation level. + */ + get is PolicyContractOps.Read< + PolicyContract, + Parameters = { + /** + * Policy Export Format. + */ + @query("format") + format?: PolicyExportFormat = PolicyExportFormat.xml; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the API operation policy specified by its identifier. + */ + getEntityTag is PolicyContractOps.CheckExistence< + PolicyContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates policy configuration for the API Operation level. + */ + createOrUpdate is PolicyContractOps.CreateOrUpdateSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes the policy configuration at the Api Operation. + */ + delete is PolicyContractOps.DeleteSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Get the list of policy configuration at the API Operation level. + */ + listByOperation is PolicyContractOps.ListSinglePage< + PolicyContract, + Response = ArmResponse + >; +} +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations +interface GraphQLApiResolverPolicyOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("apis") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + apiId: string, + + /** Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance. */ + @path + @segment("resolvers") + @key + @minLength(1) + @maxLength(80) + resolverId: string, + }, + { + /** The identifier of the Policy. */ + @path + @segment("policies") + @key + policyId: PolicyIdName, + } + > {} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations +interface GraphQLApiResolverPolicy { + /** + * Get the policy configuration at the GraphQL API Resolver level. + */ + get is GraphQLApiResolverPolicyOps.Read< + PolicyContract, + Parameters = { + /** + * Policy Export Format. + */ + @query("format") + format?: PolicyExportFormat = PolicyExportFormat.xml; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the GraphQL API resolver policy specified by its identifier. + */ + getEntityTag is GraphQLApiResolverPolicyOps.CheckExistence< + PolicyContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates policy configuration for the GraphQL API Resolver level. + */ + createOrUpdate is GraphQLApiResolverPolicyOps.CreateOrUpdateSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes the policy configuration at the GraphQL Api Resolver. + */ + delete is GraphQLApiResolverPolicyOps.DeleteSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Get the list of policy configuration at the GraphQL API Resolver level. + */ + listByResolver is GraphQLApiResolverPolicyOps.List< + PolicyContract, + Response = ArmResponse + >; +} +@armResourceOperations +interface ApiPolicyOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("apis") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + apiId: string, + }, + { + /** The identifier of the Policy. */ + @path + @segment("policies") + @key + policyId: PolicyIdName, + } + > {} + +@armResourceOperations +interface ApiPolicy { + /** + * Get the policy configuration at the API level. + */ + get is ApiPolicyOps.Read< + PolicyContract, + Parameters = { + /** + * Policy Export Format. + */ + @query("format") + format?: PolicyExportFormat = PolicyExportFormat.xml; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the API policy specified by its identifier. + */ + getEntityTag is ApiPolicyOps.CheckExistence< + PolicyContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates policy configuration for the API. + */ + createOrUpdate is ApiPolicyOps.CreateOrUpdateSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes the policy configuration at the Api. + */ + delete is ApiPolicyOps.DeleteSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Get the policy configuration at the API level. + */ + listByApi is ApiPolicyOps.ListSinglePage< + PolicyContract, + Response = ArmResponse + >; +} +@armResourceOperations +interface PolicyOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** The identifier of the Policy. */ + @path + @segment("policies") + @key + policyId: PolicyIdName, + } + > {} + +@armResourceOperations +interface Policy { + /** + * Get the Global policy definition of the Api Management service. + */ + get is PolicyOps.Read< + PolicyContract, + Parameters = { + /** + * Policy Export Format. + */ + @query("format") + format?: PolicyExportFormat = PolicyExportFormat.xml; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Global policy definition in the Api Management service. + */ + getEntityTag is PolicyOps.CheckExistence< + PolicyContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates the global policy configuration of the Api Management service. + */ + createOrUpdate is PolicyOps.CreateOrUpdateSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes the global policy configuration of the Api Management Service. + */ + delete is PolicyOps.DeleteSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all the Global Policy definitions of the Api Management service. + */ + listByService is PolicyOps.List< + PolicyContract, + Response = ArmResponse + >; +} +@armResourceOperations +interface ProductPolicyOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Product identifier. Must be unique in the current API Management service instance. */ + @path + @segment("products") + @key + @minLength(1) + @maxLength(256) + productId: string, + }, + { + /** The identifier of the Policy. */ + @path + @segment("policies") + @key + policyId: PolicyIdName, + } + > {} + +@armResourceOperations +interface ProductPolicy { + /** + * Get the policy configuration at the Product level. + */ + get is ProductPolicyOps.Read< + PolicyContract, + Parameters = { + /** + * Policy Export Format. + */ + @query("format") + format?: PolicyExportFormat = PolicyExportFormat.xml; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Get the ETag of the policy configuration at the Product level. + */ + getEntityTag is ProductPolicyOps.CheckExistence< + PolicyContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates policy configuration for the Product. + */ + createOrUpdate is ProductPolicyOps.CreateOrUpdateSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes the policy configuration at the Product. + */ + delete is ProductPolicyOps.DeleteSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Get the policy configuration at the Product level. + */ + listByProduct is ProductPolicyOps.List< + PolicyContract, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspacePolicyOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** The identifier of the Policy. */ + @path + @segment("policies") + @key + policyId: PolicyIdName, + } + > {} + +@armResourceOperations +interface WorkspacePolicy { + /** + * Get the policy configuration at the API level. + */ + get is WorkspacePolicyOps.Read< + PolicyContract, + Parameters = { + /** + * Policy Export Format. + */ + @query("format") + format?: PolicyExportFormat = PolicyExportFormat.xml; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the workspace policy specified by its identifier. + */ + getEntityTag is WorkspacePolicyOps.CheckExistence< + PolicyContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates policy configuration for the workspace. + */ + createOrUpdate is WorkspacePolicyOps.CreateOrUpdateSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes the policy configuration at the workspace. + */ + delete is WorkspacePolicyOps.DeleteSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Get the policy configuration at the workspace level. + */ + listByApi is WorkspacePolicyOps.List< + PolicyContract, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceApiOperationPolicyOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("apis") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + apiId: string, + + /** Operation identifier within an API. Must be unique in the current API Management service instance. */ + @path + @segment("operations") + @key + @minLength(1) + @maxLength(80) + operationId: string, + }, + { + /** The identifier of the Policy. */ + @path + @segment("policies") + @key + policyId: PolicyIdName, + } + > {} + +@armResourceOperations +interface WorkspaceApiOperationPolicy { + /** + * Get the policy configuration at the API Operation level. + */ + get is WorkspaceApiOperationPolicyOps.Read< + PolicyContract, + Parameters = { + /** + * Policy Export Format. + */ + @query("format") + format?: PolicyExportFormat = PolicyExportFormat.xml; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the API operation policy specified by its identifier. + */ + getEntityTag is WorkspaceApiOperationPolicyOps.CheckExistence< + PolicyContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates policy configuration for the API Operation level. + */ + createOrUpdate is WorkspaceApiOperationPolicyOps.CreateOrUpdateSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes the policy configuration at the Api Operation. + */ + delete is WorkspaceApiOperationPolicyOps.DeleteSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Get the list of policy configuration at the API Operation level. + */ + listByOperation is WorkspaceApiOperationPolicyOps.List< + PolicyContract, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceApiPolicyOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("apis") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + apiId: string, + }, + { + /** The identifier of the Policy. */ + @path + @segment("policies") + @key + policyId: PolicyIdName, + } + > {} + +@armResourceOperations +interface WorkspaceApiPolicy { + /** + * Get the policy configuration at the API level. + */ + get is WorkspaceApiPolicyOps.Read< + PolicyContract, + Parameters = { + /** + * Policy Export Format. + */ + @query("format") + format?: PolicyExportFormat = PolicyExportFormat.xml; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the API policy specified by its identifier. + */ + getEntityTag is WorkspaceApiPolicyOps.CheckExistence< + PolicyContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates policy configuration for the API. + */ + createOrUpdate is WorkspaceApiPolicyOps.CreateOrUpdateSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes the policy configuration at the Api. + */ + delete is WorkspaceApiPolicyOps.DeleteSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Get the policy configuration at the API level. + */ + listByApi is WorkspaceApiPolicyOps.List< + PolicyContract, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceProductPolicyOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + + /** Product identifier. Must be unique in the current API Management service instance. */ + @path + @segment("products") + @key + @minLength(1) + @maxLength(256) + productId: string, + }, + { + /** The identifier of the Policy. */ + @path + @segment("policies") + @key + policyId: PolicyIdName, + } + > {} + +@armResourceOperations +interface WorkspaceProductPolicy { + /** + * Get the policy configuration at the Product level. + */ + get is WorkspaceProductPolicyOps.Read< + PolicyContract, + Parameters = { + /** + * Policy Export Format. + */ + @query("format") + format?: PolicyExportFormat = PolicyExportFormat.xml; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Get the ETag of the policy configuration at the Product level. + */ + getEntityTag is WorkspaceProductPolicyOps.CheckExistence< + PolicyContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates policy configuration for the Product. + */ + createOrUpdate is WorkspaceProductPolicyOps.CreateOrUpdateSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes the policy configuration at the Product. + */ + delete is WorkspaceProductPolicyOps.DeleteSync< + PolicyContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Get the policy configuration at the Product level. + */ + listByProduct is WorkspaceProductPolicyOps.ListSinglePage< + PolicyContract, + Response = ArmResponse + >; +} + +@@doc(PolicyContract.name, "The identifier of the Policy."); +@@doc(PolicyContract.properties, "Properties of the Policy."); +@@doc(PolicyContracts.createOrUpdate::parameters.resource, + "The policy contents to apply." +); +@@doc(GraphQLApiResolverPolicy.createOrUpdate::parameters.resource, + "The policy contents to apply." +); +@@doc(ApiPolicy.createOrUpdate::parameters.resource, + "The policy contents to apply." +); +@@doc(Policy.createOrUpdate::parameters.resource, + "The policy contents to apply." +); +@@doc(ProductPolicy.createOrUpdate::parameters.resource, + "The policy contents to apply." +); +@@doc(WorkspacePolicy.createOrUpdate::parameters.resource, + "The policy contents to apply." +); +@@doc(WorkspaceApiOperationPolicy.createOrUpdate::parameters.resource, + "The policy contents to apply." +); +@@doc(WorkspaceApiPolicy.createOrUpdate::parameters.resource, + "The policy contents to apply." +); +@@doc(WorkspaceProductPolicy.createOrUpdate::parameters.resource, + "The policy contents to apply." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PolicyFragmentContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PolicyFragmentContract.tsp new file mode 100644 index 000000000000..019229f1f749 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PolicyFragmentContract.tsp @@ -0,0 +1,393 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Policy fragment contract details. + */ +@parentResource(ApiManagementServiceResource) +model PolicyFragmentContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = PolicyFragmentContract, + KeyName = "id", + SegmentName = "policyFragments", + NamePattern = "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)" + >; +} + +@armResourceOperations +interface PolicyFragmentContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** A resource identifier. */ + @path + @segment("policyFragments") + @key + @pattern("(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)") + @minLength(1) + @maxLength(80) + id: string, + } + > {} + +@armResourceOperations +interface PolicyFragmentContracts { + /** + * Gets a policy fragment. + */ + get is PolicyFragmentContractOps.Read< + PolicyFragmentContract, + Parameters = { + /** + * Policy fragment content format. + */ + @query("format") + format?: PolicyFragmentContentFormat; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of a policy fragment. + */ + getEntityTag is PolicyFragmentContractOps.CheckExistence< + PolicyFragmentContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates a policy fragment. + */ + createOrUpdate is PolicyFragmentContractOps.CreateOrUpdateAsync< + PolicyFragmentContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & + ArmCombinedLroHeaders & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmResourceCreatedResponse< + PolicyFragmentContract, + LroHeaders = ArmCombinedLroHeaders + > & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes a policy fragment. + */ + delete is PolicyFragmentContractOps.DeleteSync< + PolicyFragmentContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Gets all policy fragments. + */ + listByService is PolicyFragmentContractOps.List< + PolicyFragmentContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter, orderBy | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| value | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * OData order by query option. + */ + @query("$orderby") + $orderby?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; + + /** + * Lists policy resources that reference the policy fragment. + */ + listReferences is PolicyFragmentContractOps.ActionSync< + PolicyFragmentContract, + void, + ArmResponse, + Parameters = { + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; +} +@armResourceOperations +interface WorkspacePolicyFragmentOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** A resource identifier. */ + @path + @segment("policyFragments") + @key + @pattern("(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)") + @minLength(1) + @maxLength(80) + id: string, + } + > {} + +@armResourceOperations +interface WorkspacePolicyFragment { + /** + * Gets a policy fragment. + */ + get is WorkspacePolicyFragmentOps.Read< + PolicyFragmentContract, + Parameters = { + /** + * Policy fragment content format. + */ + @query("format") + format?: PolicyFragmentContentFormat; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of a policy fragment. + */ + getEntityTag is WorkspacePolicyFragmentOps.CheckExistence< + PolicyFragmentContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates a policy fragment. + */ + createOrUpdate is WorkspacePolicyFragmentOps.CreateOrUpdateAsync< + PolicyFragmentContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & + ArmCombinedLroHeaders & { + /** + * Current entity state version + */ + @header("ETag") + etag: string; + }) | (ArmResourceCreatedResponse< + PolicyFragmentContract, + LroHeaders = ArmCombinedLroHeaders + > & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes a policy fragment. + */ + delete is WorkspacePolicyFragmentOps.DeleteSync< + PolicyFragmentContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Gets all policy fragments defined within a workspace. + */ + listByService is WorkspacePolicyFragmentOps.List< + PolicyFragmentContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter, orderBy | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| value | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * OData order by query option. + */ + @query("$orderby") + $orderby?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; + + /** + * Lists policy resources that reference the policy fragment. + */ + listReferences is WorkspacePolicyFragmentOps.ActionSync< + PolicyFragmentContract, + void, + ArmResponse, + Parameters = { + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; +} + +@@maxLength(PolicyFragmentContract.name, 80); +@@minLength(PolicyFragmentContract.name, 1); +@@doc(PolicyFragmentContract.name, "A resource identifier."); +@@doc(PolicyFragmentContract.properties, "Properties of the Policy Fragment."); +@@doc(PolicyFragmentContracts.createOrUpdate::parameters.resource, + "The policy fragment contents to apply." +); +@@doc(WorkspacePolicyFragment.createOrUpdate::parameters.resource, + "The policy fragment contents to apply." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PolicyRestrictionContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PolicyRestrictionContract.tsp new file mode 100644 index 000000000000..d04b9044fd22 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PolicyRestrictionContract.tsp @@ -0,0 +1,147 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Policy restriction contract details. + */ +@parentResource(ApiManagementServiceResource) +model PolicyRestrictionContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = PolicyRestrictionContract, + KeyName = "policyRestrictionId", + SegmentName = "policyRestrictions", + NamePattern = "" + >; +} + +@armResourceOperations +interface PolicyRestrictionContracts { + /** + * Get the policy restriction of the Api Management service. + */ + get is ArmResourceRead< + PolicyRestrictionContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the policy restriction in the Api Management service. + */ + getEntityTag is ArmResourceCheckExistence< + PolicyRestrictionContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates the policy restriction configuration of the Api Management service. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + PolicyRestrictionContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the policy restriction configuration of the Api Management service. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + PolicyRestrictionContract, + PatchModel = PolicyRestrictionUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the policy restriction configuration of the Api Management Service. + */ + delete is ArmResourceDeleteSync< + PolicyRestrictionContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + } + >; + + /** + * Gets all policy restrictions of API Management services. + */ + listByService is ArmResourceListByParent< + PolicyRestrictionContract, + Response = ArmResponse + >; +} + +@@maxLength(PolicyRestrictionContract.name, 80); +@@minLength(PolicyRestrictionContract.name, 1); +@@doc(PolicyRestrictionContract.name, + "Policy restrictions after an entity level" +); +@@doc(PolicyRestrictionContract.properties, + "Properties of the Policy Restriction." +); +@@doc(PolicyRestrictionContracts.createOrUpdate::parameters.resource, + "The policy restriction to apply." +); +@@doc(PolicyRestrictionContracts.update::parameters.properties, + "The policy restriction to apply." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalConfigContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalConfigContract.tsp new file mode 100644 index 000000000000..aea455b47a1f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalConfigContract.tsp @@ -0,0 +1,113 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * The developer portal configuration contract. + */ +@parentResource(ApiManagementServiceResource) +model PortalConfigContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = PortalConfigContract, + KeyName = "portalConfigId", + SegmentName = "portalconfigs", + NamePattern = "" + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations +interface PortalConfigContracts { + /** + * Get the developer portal configuration. + */ + get is ArmResourceRead< + PortalConfigContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the developer portal configuration. + */ + getEntityTag is ArmResourceCheckExistence< + PortalConfigContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Create or update the developer portal configuration. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + createOrUpdate is ArmResourceCreateOrReplaceSync< + PortalConfigContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResourceUpdatedResponse + >; + + /** + * Update the developer portal configuration. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + PortalConfigContract, + PatchModel = PortalConfigContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists the developer portal configurations. + */ + listByService is ArmResourceListByParent< + PortalConfigContract, + Response = ArmResponse + >; +} + +@@maxLength(PortalConfigContract.name, 80); +@@minLength(PortalConfigContract.name, 1); +@@doc(PortalConfigContract.name, "Portal configuration identifier."); +@@doc(PortalConfigContract.properties, + "The developer portal configuration contract properties." +); +@@doc(PortalConfigContracts.createOrUpdate::parameters.resource, + "Update the developer portal configuration." +); +@@doc(PortalConfigContracts.update::parameters.properties, + "Update the developer portal configuration." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalDelegationSettings.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalDelegationSettings.tsp new file mode 100644 index 000000000000..e00af42b420d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalDelegationSettings.tsp @@ -0,0 +1,119 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Delegation settings for a developer portal. + */ +@singleton("delegation") +@parentResource(ApiManagementServiceResource) +model PortalDelegationSettings + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = PortalDelegationSettings, + KeyName = "portalsetting", + SegmentName = "portalsettings", + NamePattern = "" + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations +interface DelegationSettings { + /** + * Get Delegation Settings for the Portal. + */ + #deprecated "deprecated" + get is ArmResourceRead< + PortalDelegationSettings, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the DelegationSettings. + */ + #deprecated "deprecated" + getEntityTag is ArmResourceCheckExistence< + PortalDelegationSettings, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Create or Update Delegation settings. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #deprecated "deprecated" + createOrUpdate is ArmResourceCreateOrReplaceSync< + PortalDelegationSettings, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = ArmResourceUpdatedResponse + >; + + /** + * Update Delegation settings. + */ + #deprecated "deprecated" + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + PortalDelegationSettings, + PatchModel = PortalDelegationSettings, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmNoContentResponse + >; + + /** + * Gets the secret validation key of the DelegationSettings. + */ + #deprecated "deprecated" + listSecrets is ArmResourceActionSync< + PortalDelegationSettings, + void, + ArmResponse + >; +} + +@@doc(PortalDelegationSettings.name, ""); +@@doc(PortalDelegationSettings.properties, + "Delegation settings contract properties." +); +@@doc(DelegationSettings.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(DelegationSettings.update::parameters.properties, + "Update Delegation settings." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalRevisionContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalRevisionContract.tsp new file mode 100644 index 000000000000..455c7494b429 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalRevisionContract.tsp @@ -0,0 +1,144 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Portal Revision's contract details. + */ +@parentResource(ApiManagementServiceResource) +model PortalRevisionContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = PortalRevisionContract, + KeyName = "portalRevisionId", + SegmentName = "portalRevisions", + NamePattern = "" + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations +interface PortalRevisionContracts { + /** + * Gets the developer portal's revision specified by its identifier. + */ + get is ArmResourceRead< + PortalRevisionContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the developer portal revision specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + PortalRevisionContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + createOrUpdate is ArmResourceCreateOrReplaceAsync< + PortalRevisionContract, + Response = ArmResourceCreatedResponse< + PortalRevisionContract, + LroHeaders = ArmCombinedLroHeaders + > & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Updates the description of specified portal revision or makes it current. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync< + PortalRevisionContract, + PatchModel = PortalRevisionContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | ArmAcceptedLroResponse> + >; + + /** + * Lists developer portal's revisions. + */ + listByService is ArmResourceListByParent< + PortalRevisionContract, + Parameters = { + /** + * | Field | Supported operators | Supported functions | + * |-------------|------------------------|-----------------------------------| + * + * |name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| + * |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| + * |isCurrent | eq, ne | | + * + */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(PortalRevisionContract.name, 256); +@@minLength(PortalRevisionContract.name, 1); +@@doc(PortalRevisionContract.name, + "Portal revision identifier. Must be unique in the current API Management service instance." +); +@@doc(PortalRevisionContract.properties, "Properties of the portal revisions."); +@@doc(PortalRevisionContracts.createOrUpdate::parameters.resource, ""); +@@doc(PortalRevisionContracts.update::parameters.properties, ""); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalSigninSettings.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalSigninSettings.tsp new file mode 100644 index 000000000000..8c0bd693b444 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalSigninSettings.tsp @@ -0,0 +1,105 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Sign-In settings for the Developer Portal. + */ +@singleton("signin") +@parentResource(ApiManagementServiceResource) +model PortalSigninSettings + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = PortalSigninSettings, + KeyName = "portalsetting", + SegmentName = "portalsettings", + NamePattern = "" + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations +interface SignInSettings { + /** + * Get Sign In Settings for the Portal + */ + #deprecated "deprecated" + get is ArmResourceRead< + PortalSigninSettings, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the SignInSettings. + */ + #deprecated "deprecated" + getEntityTag is ArmResourceCheckExistence< + PortalSigninSettings, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Create or Update Sign-In settings. + */ + #deprecated "deprecated" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + createOrUpdate is ArmResourceCreateOrReplaceSync< + PortalSigninSettings, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = ArmResourceUpdatedResponse + >; + + /** + * Update Sign-In settings. + */ + #deprecated "deprecated" + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + PortalSigninSettings, + PatchModel = PortalSigninSettings, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmNoContentResponse + >; +} + +@@doc(PortalSigninSettings.name, ""); +@@doc(PortalSigninSettings.properties, "Sign-in settings contract properties."); +@@doc(SignInSettings.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(SignInSettings.update::parameters.properties, "Update Sign-In settings."); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalSignupSettings.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalSignupSettings.tsp new file mode 100644 index 000000000000..ee860a053aa1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PortalSignupSettings.tsp @@ -0,0 +1,105 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Sign-Up settings for a developer portal. + */ +@singleton("signup") +@parentResource(ApiManagementServiceResource) +model PortalSignupSettings + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = PortalSignupSettings, + KeyName = "portalsetting", + SegmentName = "portalsettings", + NamePattern = "" + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations +interface SignUpSettings { + /** + * Get Sign Up Settings for the Portal + */ + #deprecated "deprecated" + get is ArmResourceRead< + PortalSignupSettings, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the SignUpSettings. + */ + #deprecated "deprecated" + getEntityTag is ArmResourceCheckExistence< + PortalSignupSettings, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Create or Update Sign-Up settings. + */ + #deprecated "deprecated" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + createOrUpdate is ArmResourceCreateOrReplaceSync< + PortalSignupSettings, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = ArmResourceUpdatedResponse + >; + + /** + * Update Sign-Up settings. + */ + #deprecated "deprecated" + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + PortalSignupSettings, + PatchModel = PortalSignupSettings, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmNoContentResponse + >; +} + +@@doc(PortalSignupSettings.name, ""); +@@doc(PortalSignupSettings.properties, "Sign-up settings contract properties."); +@@doc(SignUpSettings.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(SignUpSettings.update::parameters.properties, "Update Sign-Up settings."); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PrivateEndpointConnection.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PrivateEndpointConnection.tsp new file mode 100644 index 000000000000..0ec7abf9a9d3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PrivateEndpointConnection.tsp @@ -0,0 +1,79 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; + +model PrivateEndpointConnection is PrivateEndpointConnectionResource; +alias PrivateEndpointOperations = PrivateEndpoints; + +@armResourceOperations +interface PrivateEndpointConnectionOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("privateEndpointConnections") + @key + privateEndpointConnectionName: string, + } + > {} + +@armResourceOperations +interface PrivateEndpointConnections { + /** + * Gets the details of the Private Endpoint Connection specified by its identifier. + */ + getByName is PrivateEndpointOperations.Read; + + /** + * Creates a new Private Endpoint Connection or updates an existing one. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + createOrUpdate is PrivateEndpointConnectionOps.CreateOrUpdateAsync< + ApiManagementServiceResource, + Request = PrivateEndpointConnectionRequest, + Response = ArmResourceUpdatedResponse | ArmAcceptedLroResponse & + Azure.Core.Foundations.RetryAfterHeader> + >; + + /** + * Deletes the specified Private Endpoint Connection. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + delete is PrivateEndpointOperations.DeleteAsync< + ApiManagementServiceResource, + Response = ArmDeletedResponse | ArmDeleteAcceptedLroResponse | ArmDeletedNoContentResponse + >; + + /** + * Lists all private endpoint connections of the API Management service instance. + */ + listByService is PrivateEndpointOperations.ListByParent; +} + +@@doc(PrivateEndpointConnection.properties, "Resource properties."); +@@doc(PrivateEndpointConnections.createOrUpdate::parameters.resource, ""); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PrivateLinkResource.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PrivateLinkResource.tsp new file mode 100644 index 000000000000..90458c0de41d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/PrivateLinkResource.tsp @@ -0,0 +1,38 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * A private link resource + */ +model PrivateLinkResource is PrivateLink; +alias PrivateLinkOperations = PrivateLinks; + +@armResourceOperations +interface PrivateLinkResources { + /** + * Gets the private link resources + */ + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ResourceManager.Legacy.renamePathParameter( + "privateLinkResourceName", + "privateLinkSubResourceName" + ) + getPrivateLinkResource is PrivateLinkOperations.Read; + + /** + * Gets the private link resources + */ + #suppress "@azure-tools/typespec-azure-resource-manager/legacy-type-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + listPrivateLinkResources is PrivateLinkOperations.ListSinglePageByParent; +} +@@doc(PrivateLinkResource.properties, "Resource properties."); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ProductApiLinkContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ProductApiLinkContract.tsp new file mode 100644 index 000000000000..5964689f5f85 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ProductApiLinkContract.tsp @@ -0,0 +1,237 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ProductContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Product-API link details. + */ +@parentResource(ProductContract) +model ProductApiLinkContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = ProductApiLinkContract, + KeyName = "apiLinkId", + SegmentName = "apiLinks", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface ProductApiLinkContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Product identifier. Must be unique in the current API Management service instance. */ + @path + @segment("products") + @key + @minLength(1) + @maxLength(256) + productId: string, + }, + { + /** Product-API link identifier. Must be unique in the current API Management service instance. */ + @path + @segment("apiLinks") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + apiLinkId: string, + } + > {} + +@armResourceOperations +interface ProductApiLinkContracts { + /** + * Gets the API link for the product. + */ + get is ProductApiLinkContractOps.Read< + ProductApiLinkContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Adds an API to the specified product via link. + */ + createOrUpdate is ProductApiLinkContractOps.CreateOrUpdateSync; + + /** + * Deletes the specified API from the specified product. + */ + delete is ProductApiLinkContractOps.DeleteSync; + + /** + * Lists a collection of the API links associated with a product. + */ + listByProduct is ProductApiLinkContractOps.List< + ProductApiLinkContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceProductApiLinkOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + + /** Product identifier. Must be unique in the current API Management service instance. */ + @path + @segment("products") + @key + @minLength(1) + @maxLength(256) + productId: string, + }, + { + /** Product-API link identifier. Must be unique in the current API Management service instance. */ + @path + @segment("apiLinks") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + apiLinkId: string, + } + > {} + +@armResourceOperations +interface WorkspaceProductApiLink { + /** + * Gets the API link for the product. + */ + get is WorkspaceProductApiLinkOps.Read< + ProductApiLinkContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Adds an API to the specified product via link. + */ + createOrUpdate is WorkspaceProductApiLinkOps.CreateOrUpdateSync; + + /** + * Deletes the specified API from the specified product. + */ + delete is WorkspaceProductApiLinkOps.DeleteSync; + + /** + * Lists a collection of the API links associated with a product. + */ + listByProduct is WorkspaceProductApiLinkOps.List< + ProductApiLinkContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(ProductApiLinkContract.name, 80); +@@minLength(ProductApiLinkContract.name, 1); +@@doc(ProductApiLinkContract.name, + "Product-API link identifier. Must be unique in the current API Management service instance." +); +@@doc(ProductApiLinkContract.properties, + "Product-API link entity contract properties." +); +@@doc(ProductApiLinkContracts.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(WorkspaceProductApiLink.createOrUpdate::parameters.resource, + "Create or update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ProductContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ProductContract.tsp new file mode 100644 index 000000000000..07d0b3ad2faf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ProductContract.tsp @@ -0,0 +1,676 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Product details. + */ +@parentResource(ApiManagementServiceResource) +model ProductContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = ProductContract, + KeyName = "productId", + SegmentName = "products", + NamePattern = "" + >; +} + +alias ProductApiParentParameters = { + ...ApiVersionParameter; + ...SubscriptionIdParameter; + ...ResourceGroupParameter; + + /** + * The name of the API Management service. + */ + @path + @segment("service") + @key + @minLength(1) + @maxLength(50) + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + serviceName: string; + + /** + * Product identifier. Must be unique in the current API Management service instance. + */ + @path + @minLength(1) + @maxLength(256) + @segment("products") + productId: string; +}; + +alias ProductApiParameters = { + /** + * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. + */ + @maxLength(256) + @minLength(1) + @pattern("^[^*#&+:<>?]+$") + @path + @segment("apis") + apiId: string; +}; + +alias ProductApiOps = Azure.ResourceManager.Legacy.RoutedOperations< + ProductApiParentParameters, + ProductApiParameters, + ResourceRoute = #{ + route: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis", + } +>; + +alias ProductGroupParentParameters = { + ...ApiVersionParameter; + ...SubscriptionIdParameter; + ...ResourceGroupParameter; + + /** + * The name of the API Management service. + */ + @path + @segment("service") + @key + @minLength(1) + @maxLength(50) + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + serviceName: string; + + /** + * Product identifier. Must be unique in the current API Management service instance. + */ + @path + @minLength(1) + @maxLength(256) + @segment("products") + productId: string; +}; + +alias ProductGroupParameters = { + /** + * Group identifier. Must be unique in the current API Management service instance. + */ + @maxLength(256) + @minLength(1) + @path + @segment("groups") + groupId: string; +}; + +alias ProductGroupOps = Azure.ResourceManager.Legacy.RoutedOperations< + ProductGroupParentParameters, + ProductGroupParameters, + ResourceRoute = #{ + route: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups", + } +>; + +@armResourceOperations +interface ProductContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** Product identifier. Must be unique in the current API Management service instance. */ + @path + @segment("products") + @key + @minLength(1) + @maxLength(256) + productId: string, + } + > {} + +@armResourceOperations(#{ allowStaticRoutes: true }) +interface ProductContracts { + /** + * Gets the details of the product specified by its identifier. + */ + get is ProductContractOps.Read< + ProductContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the product specified by its identifier. + */ + getEntityTag is ProductContractOps.CheckExistence< + ProductContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or Updates a product. + */ + createOrUpdate is ProductContractOps.CreateOrUpdateSync< + ProductContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Update existing product details. + */ + @patch(#{ implicitOptionality: false }) + update is ProductContractOps.CustomPatchSync< + ProductContract, + PatchModel = ProductUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Delete product. + */ + delete is ProductContractOps.DeleteSync< + ProductContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + + /** + * Delete existing subscriptions associated with the product or not. + */ + @query("deleteSubscriptions") + deleteSubscriptions?: boolean; + } + >; + + /** + * Lists a collection of products in the specified service instance. + */ + listByService is ProductContractOps.List< + ProductContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| groups | expand | | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * When set to true, the response contains an array of groups that have visibility to the product. The default is false. + */ + @query("expandGroups") + expandGroups?: boolean; + + /** + * Products which are part of a specific tag. + */ + @query("tags") + tags?: string; + }, + Response = ArmResponse + >; + + /** + * Lists a collection of the APIs associated with a product. + */ + @get + @action("apis") + @list + listByProduct is ProductContractOps.ActionSync< + ProductContract, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; + + /** + * Checks that API entity specified by identifier is associated with the Product entity. + */ + @head + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}") + checkEntityExists is ProductApiOps.ActionSync< + ProductContract, + void, + Response = NoContentResponse + >; + + /** + * Adds an API to the specified product. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation-response" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @put + productApiCreateOrUpdate is ProductContractOps.CreateOrUpdateSync< + ProductContract, + Request = void, + Response = ArmResponse | ArmResourceCreatedSyncResponse, + Parameters = { + /** + * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. + */ + @maxLength(256) + @minLength(1) + @pattern("^[^*#&+:<>?]+$") + @path + @segment("apis") + apiId: string; + } + >; + + /** + * Deletes the specified API from the specified product. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @delete + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}") + productApiDelete is ProductApiOps.ActionSync< + ProductContract, + void, + Response = OkResponse | NoContentResponse + >; + + /** + * Lists the collection of developer groups associated with the specified product. + */ + @get + @action("groups") + @list + productGroupListByProduct is ProductContractOps.ActionSync< + ProductContract, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | |
| displayName | filter | eq, ne | |
| description | filter | eq, ne | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; + + /** + * Checks that Group entity specified by identifier is associated with the Product entity. + */ + @head + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}") + productGroupCheckEntityExists is ProductGroupOps.ActionSync< + ProductContract, + void, + Response = NoContentResponse + >; + + /** + * Adds the association between the specified developer group with the specified product. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation-response" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @put + productGroupCreateOrUpdate is ProductContractOps.CreateOrUpdateSync< + ProductContract, + Request = void, + Response = ArmResponse | ArmResourceCreatedSyncResponse, + Parameters = { + /** + * Group identifier. Must be unique in the current API Management service instance. + */ + @maxLength(256) + @minLength(1) + @path + @segment("groups") + groupId: string; + } + >; + + /** + * Deletes the association between the specified group and product. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @delete + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}") + productGroupDelete is ProductGroupOps.ActionSync< + ProductContract, + void, + Response = OkResponse | NoContentResponse + >; + + /** + * Lists the collection of subscriptions to the specified product. + */ + @get + @action("subscriptions") + @list + list is ProductContractOps.ActionSync< + ProductContract, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; +} +@armResourceOperations +interface WorkspaceProductOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** Product identifier. Must be unique in the current API Management service instance. */ + @path + @segment("products") + @key + @minLength(1) + @maxLength(256) + productId: string, + } + > {} + +@armResourceOperations +interface WorkspaceProduct { + /** + * Gets the details of the product specified by its identifier. + */ + get is WorkspaceProductOps.Read< + ProductContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the product specified by its identifier. + */ + getEntityTag is WorkspaceProductOps.CheckExistence< + ProductContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or Updates a product. + */ + createOrUpdate is WorkspaceProductOps.CreateOrUpdateSync< + ProductContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Update existing product details. + */ + @patch(#{ implicitOptionality: false }) + update is WorkspaceProductOps.CustomPatchSync< + ProductContract, + PatchModel = ProductUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Delete product. + */ + delete is WorkspaceProductOps.DeleteSync< + ProductContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + + /** + * Delete existing subscriptions associated with the product or not. + */ + @query("deleteSubscriptions") + deleteSubscriptions?: boolean; + } + >; + + /** + * Lists a collection of products in the specified workspace in a service instance. + */ + listByService is WorkspaceProductOps.List< + ProductContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| groups | expand | | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * When set to true, the response contains an array of groups that have visibility to the product. The default is false. + */ + @query("expandGroups") + expandGroups?: boolean; + + /** + * Products which are part of a specific tag. + */ + @query("tags") + tags?: string; + }, + Response = ArmResponse + >; +} + +@@maxLength(ProductContract.name, 256); +@@minLength(ProductContract.name, 1); +@@doc(ProductContract.name, + "Product identifier. Must be unique in the current API Management service instance." +); +@@doc(ProductContract.properties, "Product entity contract properties."); +@@doc(ProductContracts.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(ProductContracts.update::parameters.properties, "Update parameters."); +@@doc(WorkspaceProduct.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(WorkspaceProduct.update::parameters.properties, "Update parameters."); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ProductGroupLinkContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ProductGroupLinkContract.tsp new file mode 100644 index 000000000000..5822ca1285b8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ProductGroupLinkContract.tsp @@ -0,0 +1,237 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ProductContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Product-group link details. + */ +@parentResource(ProductContract) +model ProductGroupLinkContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = ProductGroupLinkContract, + KeyName = "groupLinkId", + SegmentName = "groupLinks", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface ProductGroupLinkContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Product identifier. Must be unique in the current API Management service instance. */ + @path + @segment("products") + @key + @minLength(1) + @maxLength(256) + productId: string, + }, + { + /** Product-Group link identifier. Must be unique in the current API Management service instance. */ + @path + @segment("groupLinks") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + groupLinkId: string, + } + > {} + +@armResourceOperations +interface ProductGroupLinkContracts { + /** + * Gets the group link for the product. + */ + get is ProductGroupLinkContractOps.Read< + ProductGroupLinkContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Adds a group to the specified product via link. + */ + createOrUpdate is ProductGroupLinkContractOps.CreateOrUpdateSync; + + /** + * Deletes the specified group from the specified product. + */ + delete is ProductGroupLinkContractOps.DeleteSync; + + /** + * Lists a collection of the group links associated with a product. + */ + listByProduct is ProductGroupLinkContractOps.List< + ProductGroupLinkContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| groupId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceProductGroupLinkOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + + /** Product identifier. Must be unique in the current API Management service instance. */ + @path + @segment("products") + @key + @minLength(1) + @maxLength(256) + productId: string, + }, + { + /** Product-Group link identifier. Must be unique in the current API Management service instance. */ + @path + @segment("groupLinks") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + groupLinkId: string, + } + > {} + +@armResourceOperations +interface WorkspaceProductGroupLink { + /** + * Gets the group link for the product. + */ + get is WorkspaceProductGroupLinkOps.Read< + ProductGroupLinkContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Adds a group to the specified product via link. + */ + createOrUpdate is WorkspaceProductGroupLinkOps.CreateOrUpdateSync; + + /** + * Deletes the specified group from the specified product. + */ + delete is WorkspaceProductGroupLinkOps.DeleteSync; + + /** + * Lists a collection of the group links associated with a product. + */ + listByProduct is WorkspaceProductGroupLinkOps.List< + ProductGroupLinkContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| groupId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(ProductGroupLinkContract.name, 80); +@@minLength(ProductGroupLinkContract.name, 1); +@@doc(ProductGroupLinkContract.name, + "Product-Group link identifier. Must be unique in the current API Management service instance." +); +@@doc(ProductGroupLinkContract.properties, + "Product-group link entity contract properties." +); +@@doc(ProductGroupLinkContracts.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(WorkspaceProductGroupLink.createOrUpdate::parameters.resource, + "Create or update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ResolverContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ResolverContract.tsp new file mode 100644 index 000000000000..e69ac7c27862 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/ResolverContract.tsp @@ -0,0 +1,166 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * GraphQL API Resolver details. + */ +@parentResource(ApiContract) +model ResolverContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = ResolverContract, + KeyName = "resolverId", + SegmentName = "resolvers", + NamePattern = "" + >; +} + +@armResourceOperations +interface ResolverContracts { + /** + * Gets the details of the GraphQL API Resolver specified by its identifier. + */ + get is ArmResourceRead< + ResolverContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the GraphQL API resolver specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + ResolverContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new resolver in the GraphQL API or updates an existing one. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + ResolverContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the resolver in the GraphQL API specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + ResolverContract, + PatchModel = ResolverUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified resolver in the GraphQL API. + */ + delete is ArmResourceDeleteSync< + ResolverContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of the resolvers for the specified GraphQL API. + */ + listByApi is ArmResourceListByParent< + ResolverContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(ResolverContract.name, 80); +@@minLength(ResolverContract.name, 1); +@@doc(ResolverContract.name, + "Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance." +); +@@doc(ResolverContract.properties, "Properties of the Resolver Contract."); +@@doc(ResolverContracts.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(ResolverContracts.update::parameters.properties, + "GraphQL API Resolver Update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/SchemaContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/SchemaContract.tsp new file mode 100644 index 000000000000..6c2dd45708b7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/SchemaContract.tsp @@ -0,0 +1,345 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * API Schema Contract details. + */ +@parentResource(ApiContract) +model SchemaContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = SchemaContract, + KeyName = "schemaId", + SegmentName = "schemas", + NamePattern = "" + >; +} + +@armResourceOperations +interface SchemaContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("apis") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + apiId: string, + }, + { + /** Schema id identifier. Must be unique in the current API Management service instance. */ + @path + @segment("schemas") + @key + @minLength(1) + @maxLength(80) + schemaId: string, + } + > {} + +@armResourceOperations +interface SchemaContracts { + /** + * Get the schema configuration at the API level. + */ + get is SchemaContractOps.Read< + SchemaContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the schema specified by its identifier. + */ + getEntityTag is SchemaContractOps.CheckExistence< + SchemaContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates schema configuration for the API. + */ + createOrUpdate is SchemaContractOps.CreateOrUpdateAsync< + SchemaContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & + ArmCombinedLroHeaders & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & + ArmCombinedLroHeaders & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes the schema configuration at the Api. + */ + delete is SchemaContractOps.DeleteSync< + SchemaContract, + Parameters = { + /** + * If true removes all references to the schema before deleting it. + */ + @query("force") + force?: boolean; + + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Get the schema configuration at the API level. + */ + listByApi is SchemaContractOps.List< + SchemaContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceApiSchemaOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("apis") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + apiId: string, + }, + { + /** Schema id identifier. Must be unique in the current API Management service instance. */ + @path + @segment("schemas") + @key + @minLength(1) + @maxLength(80) + schemaId: string, + } + > {} + +@armResourceOperations +interface WorkspaceApiSchema { + /** + * Get the schema configuration at the API level. + */ + get is WorkspaceApiSchemaOps.Read< + SchemaContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the schema specified by its identifier. + */ + getEntityTag is WorkspaceApiSchemaOps.CheckExistence< + SchemaContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates schema configuration for the API. + */ + createOrUpdate is WorkspaceApiSchemaOps.CreateOrUpdateAsync< + SchemaContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & + ArmCombinedLroHeaders & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmResourceCreatedResponse & + ArmCombinedLroHeaders & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Deletes the schema configuration at the Api. + */ + delete is WorkspaceApiSchemaOps.DeleteSync< + SchemaContract, + Parameters = { + /** + * If true removes all references to the schema before deleting it. + */ + @query("force") + force?: boolean; + + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Get the schema configuration at the API level. + */ + listByApi is WorkspaceApiSchemaOps.List< + SchemaContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(SchemaContract.name, 80); +@@minLength(SchemaContract.name, 1); +@@doc(SchemaContract.name, + "Schema id identifier. Must be unique in the current API Management service instance." +); +@@doc(SchemaContract.properties, "Properties of the API Schema."); +@@doc(SchemaContracts.createOrUpdate::parameters.resource, + "The schema contents to apply." +); +@@doc(WorkspaceApiSchema.createOrUpdate::parameters.resource, + "The schema contents to apply." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/SubscriptionContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/SubscriptionContract.tsp new file mode 100644 index 000000000000..ec735a750330 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/SubscriptionContract.tsp @@ -0,0 +1,570 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Subscription details. + */ +@parentResource(ApiManagementServiceResource) +model SubscriptionContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = SubscriptionContract, + KeyName = "sid", + SegmentName = "subscriptions", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface SubscriptionContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** Subscription entity Identifier. The entity represents the association between a user and a product in API Management. */ + @path + @segment("subscriptions") + @key + @pattern("^[^*#&+:<>?]+$") + @maxLength(256) + sid: string, + } + > {} + +@armResourceOperations +interface SubscriptionContracts { + /** + * Gets the specified Subscription entity. + */ + get is SubscriptionContractOps.Read< + SubscriptionContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier. + */ + getEntityTag is SubscriptionContractOps.CheckExistence< + SubscriptionContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates the subscription of specified user to the specified product. + */ + createOrUpdate is SubscriptionContractOps.CreateOrUpdateSync< + SubscriptionContract, + Request = SubscriptionCreateParameters, + Parameters = { + /** + * Notify change in Subscription State. + * - If false, do not send any email notification for change of state of subscription + * - If true, send email notification of change of state of subscription + */ + @query("notify") + notify?: boolean; + + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + + /** + * Determines the type of application which send the create user request. Default is legacy publisher portal. + */ + @query("appType") + appType?: AppType; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of a subscription specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is SubscriptionContractOps.CustomPatchSync< + SubscriptionContract, + PatchModel = SubscriptionUpdateParameters, + Parameters = { + /** + * Notify change in Subscription State. + * - If false, do not send any email notification for change of state of subscription + * - If true, send email notification of change of state of subscription + */ + @query("notify") + notify?: boolean; + + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + + /** + * Determines the type of application which send the create user request. Default is legacy publisher portal. + */ + @query("appType") + appType?: AppType; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified subscription. + */ + delete is SubscriptionContractOps.DeleteSync< + SubscriptionContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all subscriptions of the API Management service instance. + */ + list is SubscriptionContractOps.List< + SubscriptionContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; + + /** + * Regenerates primary key of existing subscription of the API Management service instance. + */ + regeneratePrimaryKey is SubscriptionContractOps.ActionSync< + SubscriptionContract, + void, + NoContentResponse + >; + + /** + * Regenerates secondary key of existing subscription of the API Management service instance. + */ + regenerateSecondaryKey is SubscriptionContractOps.ActionSync< + SubscriptionContract, + void, + NoContentResponse + >; + + /** + * Gets the specified Subscription keys. + */ + listSecrets is SubscriptionContractOps.ActionSync< + SubscriptionContract, + void, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; +} +@armResourceOperations +interface UserSubscriptionOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** User identifier. Must be unique in the current API Management service instance. */ + @path + @segment("users") + @key + @minLength(1) + @maxLength(80) + userId: string, + }, + { + /** Subscription entity Identifier. The entity represents the association between a user and a product in API Management. */ + @path + @segment("subscriptions") + @key + @pattern("^[^*#&+:<>?]+$") + @maxLength(256) + sid: string, + } + > {} + +@armResourceOperations +interface UserSubscription { + /** + * Gets the specified Subscription entity associated with a particular user. + */ + get is UserSubscriptionOps.Read< + SubscriptionContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Lists the collection of subscriptions of the specified user. + */ + list is UserSubscriptionOps.List< + SubscriptionContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|------------------------|-----------------------------------|
|name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceSubscriptionOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** Subscription entity Identifier. The entity represents the association between a user and a product in API Management. */ + @path + @segment("subscriptions") + @key + @pattern("^[^*#&+:<>?]+$") + @maxLength(256) + sid: string, + } + > {} + +@armResourceOperations +interface WorkspaceSubscription { + /** + * Gets the specified Subscription entity. + */ + get is WorkspaceSubscriptionOps.Read< + SubscriptionContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier. + */ + getEntityTag is WorkspaceSubscriptionOps.CheckExistence< + SubscriptionContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or updates the subscription of specified user to the specified product. + */ + createOrUpdate is WorkspaceSubscriptionOps.CreateOrUpdateSync< + SubscriptionContract, + Request = SubscriptionCreateParameters, + Parameters = { + /** + * Notify change in Subscription State. + * - If false, do not send any email notification for change of state of subscription + * - If true, send email notification of change of state of subscription + */ + @query("notify") + notify?: boolean; + + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + + /** + * Determines the type of application which send the create user request. Default is legacy publisher portal. + */ + @query("appType") + appType?: AppType; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of a subscription specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is WorkspaceSubscriptionOps.CustomPatchSync< + SubscriptionContract, + PatchModel = SubscriptionUpdateParameters, + Parameters = { + /** + * Notify change in Subscription State. + * - If false, do not send any email notification for change of state of subscription + * - If true, send email notification of change of state of subscription + */ + @query("notify") + notify?: boolean; + + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + + /** + * Determines the type of application which send the create user request. Default is legacy publisher portal. + */ + @query("appType") + appType?: AppType; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified subscription. + */ + delete is WorkspaceSubscriptionOps.DeleteSync< + SubscriptionContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all subscriptions of the workspace in an API Management service instance. + */ + list is WorkspaceSubscriptionOps.List< + SubscriptionContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; + + /** + * Regenerates primary key of existing subscription of the workspace in an API Management service instance. + */ + regeneratePrimaryKey is WorkspaceSubscriptionOps.ActionSync< + SubscriptionContract, + void, + NoContentResponse + >; + + /** + * Regenerates secondary key of existing subscription of the workspace in an API Management service instance. + */ + regenerateSecondaryKey is WorkspaceSubscriptionOps.ActionSync< + SubscriptionContract, + void, + NoContentResponse + >; + + /** + * Gets the specified Subscription keys. + */ + listSecrets is WorkspaceSubscriptionOps.ActionSync< + SubscriptionContract, + void, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; +} + +@@maxLength(SubscriptionContract.name, 256); +@@doc(SubscriptionContract.name, + "Subscription entity Identifier. The entity represents the association between a user and a product in API Management." +); +@@doc(SubscriptionContract.properties, "Subscription contract properties."); +@@doc(SubscriptionContracts.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(SubscriptionContracts.update::parameters.properties, + "Update parameters." +); +@@doc(WorkspaceSubscription.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(WorkspaceSubscription.update::parameters.properties, + "Update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagApiLinkContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagApiLinkContract.tsp new file mode 100644 index 000000000000..52840c934d02 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagApiLinkContract.tsp @@ -0,0 +1,239 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./TagContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Tag-API link details. + */ +@parentResource(TagContract) +model TagApiLinkContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = TagApiLinkContract, + KeyName = "apiLinkId", + SegmentName = "apiLinks", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface TagApiLinkContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Tag identifier. Must be unique in the current API Management service instance. */ + @path + @segment("tags") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + tagId: string, + }, + { + /** Tag-API link identifier. Must be unique in the current API Management service instance. */ + @path + @segment("apiLinks") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + apiLinkId: string, + } + > {} + +@armResourceOperations +interface TagApiLinkContracts { + /** + * Gets the API link for the tag. + */ + get is TagApiLinkContractOps.Read< + TagApiLinkContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Adds an API to the specified tag via link. + */ + createOrUpdate is TagApiLinkContractOps.CreateOrUpdateSync; + + /** + * Deletes the specified API from the specified tag. + */ + delete is TagApiLinkContractOps.DeleteSync; + + /** + * Lists a collection of the API links associated with a tag. + */ + listByProduct is TagApiLinkContractOps.List< + TagApiLinkContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceTagApiLinkOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + + /** Tag identifier. Must be unique in the current API Management service instance. */ + @path + @segment("tags") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + tagId: string, + }, + { + /** Tag-API link identifier. Must be unique in the current API Management service instance. */ + @path + @segment("apiLinks") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + apiLinkId: string, + } + > {} + +@armResourceOperations +interface WorkspaceTagApiLink { + /** + * Gets the API link for the tag. + */ + get is WorkspaceTagApiLinkOps.Read< + TagApiLinkContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Adds an API to the specified tag via link. + */ + createOrUpdate is WorkspaceTagApiLinkOps.CreateOrUpdateSync; + + /** + * Deletes the specified API from the specified tag. + */ + delete is WorkspaceTagApiLinkOps.DeleteSync; + + /** + * Lists a collection of the API links associated with a tag. + */ + listByProduct is WorkspaceTagApiLinkOps.List< + TagApiLinkContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(TagApiLinkContract.name, 80); +@@minLength(TagApiLinkContract.name, 1); +@@doc(TagApiLinkContract.name, + "Tag-API link identifier. Must be unique in the current API Management service instance." +); +@@doc(TagApiLinkContract.properties, + "Tag-API link entity contract properties." +); +@@doc(TagApiLinkContracts.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(WorkspaceTagApiLink.createOrUpdate::parameters.resource, + "Create or update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagContract.tsp new file mode 100644 index 000000000000..af1483c8f0b9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagContract.tsp @@ -0,0 +1,733 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./OperationContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Tag Contract details. + */ +@parentResource(OperationContract) +model TagContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = TagContract, + KeyName = "tagId", + SegmentName = "tags", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface TagContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("apis") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + apiId: string, + + /** Operation identifier within an API. Must be unique in the current API Management service instance. */ + @path + @segment("operations") + @key + @minLength(1) + @maxLength(80) + operationId: string, + }, + { + /** Tag identifier. Must be unique in the current API Management service instance. */ + @path + @segment("tags") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + tagId: string, + } + > {} + +@armResourceOperations +interface TagContracts { + /** + * Get tag associated with the Operation. + */ + getByOperation is TagContractOps.Read< + TagContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state version of the tag specified by its identifier. + */ + getEntityStateByOperation is TagContractOps.CheckExistence< + TagContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + // FIXME: (ArmResourceCreateOrReplace): ArmResourceCreateOrReplaceAsync/ArmResourceCreateOrReplaceSync should have a body parameter. + /** + * Assign tag to the Operation. + */ + assignToOperation is TagContractOps.CreateOrUpdateSync< + TagContract, + Request = void + >; + + /** + * Detach the tag from the Operation. + */ + detachFromOperation is TagContractOps.DeleteSync; + + /** + * Lists all Tags associated with the Operation. + */ + listByOperation is TagContractOps.List< + TagContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface TagOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("apis") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + apiId: string, + }, + { + /** Tag identifier. Must be unique in the current API Management service instance. */ + @path + @segment("tags") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + tagId: string, + } + > {} + +@armResourceOperations +interface Tag { + /** + * Get tag associated with the API. + */ + getByApi is TagOps.Read< + TagContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state version of the tag specified by its identifier. + */ + getEntityStateByApi is TagOps.CheckExistence< + TagContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + // FIXME: (ArmResourceCreateOrReplace): ArmResourceCreateOrReplaceAsync/ArmResourceCreateOrReplaceSync should have a body parameter. + /** + * Assign tag to the Api. + */ + assignToApi is TagOps.CreateOrUpdateSync< + TagContract, + Request = void, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Detach the tag from the Api. + */ + detachFromApi is TagOps.DeleteSync; + + /** + * Lists all Tags associated with the API. + */ + listByApi is TagOps.List< + TagContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface TagContractOperationOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Product identifier. Must be unique in the current API Management service instance. */ + @path + @segment("products") + @key + @minLength(1) + @maxLength(256) + productId: string, + }, + { + /** Tag identifier. Must be unique in the current API Management service instance. */ + @path + @segment("tags") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + tagId: string, + } + > {} + +@armResourceOperations +interface TagContractOperation { + /** + * Get tag associated with the Product. + */ + getByProduct is TagContractOperationOps.Read< + TagContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state version of the tag specified by its identifier. + */ + getEntityStateByProduct is TagContractOperationOps.CheckExistence< + TagContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + // FIXME: (ArmResourceCreateOrReplace): ArmResourceCreateOrReplaceAsync/ArmResourceCreateOrReplaceSync should have a body parameter. + /** + * Assign tag to the Product. + */ + assignToProduct is TagContractOperationOps.CreateOrUpdateSync< + TagContract, + Request = void + >; + + /** + * Detach the tag from the Product. + */ + detachFromProduct is TagContractOperationOps.DeleteSync; + + /** + * Lists all Tags associated with the Product. + */ + listByProduct is TagContractOperationOps.List< + TagContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface TagContractOperationGroupOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** Tag identifier. Must be unique in the current API Management service instance. */ + @path + @segment("tags") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + tagId: string, + } + > {} + +@armResourceOperations +interface TagContractOperationGroup { + /** + * Gets the details of the tag specified by its identifier. + */ + get is TagContractOperationGroupOps.Read< + TagContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state version of the tag specified by its identifier. + */ + getEntityState is TagContractOperationGroupOps.CheckExistence< + TagContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a tag. + */ + createOrUpdate is TagContractOperationGroupOps.CreateOrUpdateSync< + TagContract, + Request = TagCreateUpdateParameters, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the tag specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is TagContractOperationGroupOps.CustomPatchSync< + TagContract, + PatchModel = TagCreateUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes specific tag of the API Management service instance. + */ + delete is TagContractOperationGroupOps.DeleteSync< + TagContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of tags defined within a service instance. + */ + listByService is TagContractOperationGroupOps.List< + TagContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * Scope like 'apis', 'products' or 'apis/{apiId} + */ + @query("scope") + scope?: string; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceTagOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + }, + { + /** Tag identifier. Must be unique in the current API Management service instance. */ + @path + @segment("tags") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + tagId: string, + } + > {} + +@armResourceOperations +interface WorkspaceTag { + /** + * Gets the details of the tag specified by its identifier. + */ + get is WorkspaceTagOps.Read< + TagContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state version of the tag specified by its identifier. + */ + getEntityState is WorkspaceTagOps.CheckExistence< + TagContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a tag. + */ + createOrUpdate is WorkspaceTagOps.CreateOrUpdateSync< + TagContract, + Request = TagCreateUpdateParameters, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the tag specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is WorkspaceTagOps.CustomPatchSync< + TagContract, + PatchModel = TagCreateUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes specific tag of the workspace in an API Management service instance. + */ + delete is WorkspaceTagOps.DeleteSync< + TagContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists a collection of tags defined within a workspace in a service instance. + */ + listByService is WorkspaceTagOps.List< + TagContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * Scope like 'apis', 'products' or 'apis/{apiId} + */ + @query("scope") + scope?: string; + }, + Response = ArmResponse + >; +} + +@@maxLength(TagContract.name, 80); +@@minLength(TagContract.name, 1); +@@doc(TagContract.name, + "Tag identifier. Must be unique in the current API Management service instance." +); +@@doc(TagContract.properties, "Tag entity contract properties."); +@@doc(TagContractOperationGroup.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(TagContractOperationGroup.update::parameters.properties, + "Update parameters." +); +@@doc(WorkspaceTag.createOrUpdate::parameters.resource, "Create parameters."); +@@doc(WorkspaceTag.update::parameters.properties, "Update parameters."); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagDescriptionContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagDescriptionContract.tsp new file mode 100644 index 000000000000..1520bfd7607e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagDescriptionContract.tsp @@ -0,0 +1,183 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Contract details. + */ +@parentResource(ApiContract) +model TagDescriptionContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = TagDescriptionContract, + KeyName = "tagDescriptionId", + SegmentName = "tagDescriptions", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface TagDescriptionContractsOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** + * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. + */ + @path + @segment("apis") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(256) + apiId: string, + }, + { + /** Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names. */ + @path + @segment("tagDescriptions") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + tagDescriptionId: string, + } + > {} + +@armResourceOperations +interface TagDescriptionContracts { + /** + * Get Tag description in scope of API + */ + get is ArmResourceRead< + TagDescriptionContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state version of the tag specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + TagDescriptionContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Create/Update tag description in scope of the Api. + */ + createOrUpdate is TagDescriptionContractsOps.CreateOrUpdateSync< + TagDescriptionContract, + Request = TagDescriptionCreateParameters, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Delete tag description for the Api. + */ + delete is ArmResourceDeleteSync< + TagDescriptionContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations + */ + listByService is ArmResourceListByParent< + TagDescriptionContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(TagDescriptionContract.name, 80); +@@minLength(TagDescriptionContract.name, 1); +@@doc(TagDescriptionContract.name, + "Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names." +); +@@doc(TagDescriptionContract.properties, + "TagDescription entity contract properties." +); +@@doc(TagDescriptionContracts.createOrUpdate::parameters.resource, + "Create parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagOperationLinkContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagOperationLinkContract.tsp new file mode 100644 index 000000000000..63f80daebd66 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagOperationLinkContract.tsp @@ -0,0 +1,239 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./TagContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Tag-operation link details. + */ +@parentResource(TagContract) +model TagOperationLinkContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = TagOperationLinkContract, + KeyName = "operationLinkId", + SegmentName = "operationLinks", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface TagOperationLinkContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Tag identifier. Must be unique in the current API Management service instance. */ + @path + @segment("tags") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + tagId: string, + }, + { + /** Tag-operation link identifier. Must be unique in the current API Management service instance. */ + @path + @segment("operationLinks") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + operationLinkId: string, + } + > {} + +@armResourceOperations +interface TagOperationLinkContracts { + /** + * Gets the operation link for the tag. + */ + get is TagOperationLinkContractOps.Read< + TagOperationLinkContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Adds an operation to the specified tag via link. + */ + createOrUpdate is TagOperationLinkContractOps.CreateOrUpdateSync; + + /** + * Deletes the specified operation from the specified tag. + */ + delete is TagOperationLinkContractOps.DeleteSync; + + /** + * Lists a collection of the operation links associated with a tag. + */ + listByProduct is TagOperationLinkContractOps.List< + TagOperationLinkContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| operationId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceTagOperationLinkOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + + /** Tag identifier. Must be unique in the current API Management service instance. */ + @path + @segment("tags") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + tagId: string, + }, + { + /** Tag-operation link identifier. Must be unique in the current API Management service instance. */ + @path + @segment("operationLinks") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + operationLinkId: string, + } + > {} + +@armResourceOperations +interface WorkspaceTagOperationLink { + /** + * Gets the operation link for the tag. + */ + get is WorkspaceTagOperationLinkOps.Read< + TagOperationLinkContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Adds an operation to the specified tag via link. + */ + createOrUpdate is WorkspaceTagOperationLinkOps.CreateOrUpdateSync; + + /** + * Deletes the specified operation from the specified tag. + */ + delete is WorkspaceTagOperationLinkOps.DeleteSync; + + /** + * Lists a collection of the operation links associated with a tag. + */ + listByProduct is WorkspaceTagOperationLinkOps.List< + TagOperationLinkContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| operationId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(TagOperationLinkContract.name, 80); +@@minLength(TagOperationLinkContract.name, 1); +@@doc(TagOperationLinkContract.name, + "Tag-operation link identifier. Must be unique in the current API Management service instance." +); +@@doc(TagOperationLinkContract.properties, + "Tag-API link entity contract properties." +); +@@doc(TagOperationLinkContracts.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(WorkspaceTagOperationLink.createOrUpdate::parameters.resource, + "Create or update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagProductLinkContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagProductLinkContract.tsp new file mode 100644 index 000000000000..abeaf492e4cb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TagProductLinkContract.tsp @@ -0,0 +1,239 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./TagContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Tag-product link details. + */ +@parentResource(TagContract) +model TagProductLinkContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = TagProductLinkContract, + KeyName = "productLinkId", + SegmentName = "productLinks", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface TagProductLinkContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Tag identifier. Must be unique in the current API Management service instance. */ + @path + @segment("tags") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + tagId: string, + }, + { + /** Tag-product link identifier. Must be unique in the current API Management service instance. */ + @path + @segment("productLinks") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + productLinkId: string, + } + > {} + +@armResourceOperations +interface TagProductLinkContracts { + /** + * Gets the product link for the tag. + */ + get is TagProductLinkContractOps.Read< + TagProductLinkContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Adds a product to the specified tag via link. + */ + createOrUpdate is TagProductLinkContractOps.CreateOrUpdateSync; + + /** + * Deletes the specified product from the specified tag. + */ + delete is TagProductLinkContractOps.DeleteSync; + + /** + * Lists a collection of the product links associated with a tag. + */ + listByProduct is TagProductLinkContractOps.List< + TagProductLinkContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface WorkspaceTagProductLinkOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Workspace identifier. Must be unique in the current API Management service instance. */ + @path + @segment("workspaces") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + workspaceId: string, + + /** Tag identifier. Must be unique in the current API Management service instance. */ + @path + @segment("tags") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + tagId: string, + }, + { + /** Tag-product link identifier. Must be unique in the current API Management service instance. */ + @path + @segment("productLinks") + @key + @pattern("^[^*#&+:<>?]+$") + @minLength(1) + @maxLength(80) + productLinkId: string, + } + > {} + +@armResourceOperations +interface WorkspaceTagProductLink { + /** + * Gets the product link for the tag. + */ + get is WorkspaceTagProductLinkOps.Read< + TagProductLinkContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Adds a product to the specified tag via link. + */ + createOrUpdate is WorkspaceTagProductLinkOps.CreateOrUpdateSync; + + /** + * Deletes the specified product from the specified tag. + */ + delete is WorkspaceTagProductLinkOps.DeleteSync; + + /** + * Lists a collection of the product links associated with a tag. + */ + listByProduct is WorkspaceTagProductLinkOps.List< + TagProductLinkContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(TagProductLinkContract.name, 80); +@@minLength(TagProductLinkContract.name, 1); +@@doc(TagProductLinkContract.name, + "Tag-product link identifier. Must be unique in the current API Management service instance." +); +@@doc(TagProductLinkContract.properties, + "Tag-API link entity contract properties." +); +@@doc(TagProductLinkContracts.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(WorkspaceTagProductLink.createOrUpdate::parameters.resource, + "Create or update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TenantSettingsContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TenantSettingsContract.tsp new file mode 100644 index 000000000000..4e7b3ab9483c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/TenantSettingsContract.tsp @@ -0,0 +1,66 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Tenant Settings. + */ +@parentResource(ApiManagementServiceResource) +model TenantSettingsContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = TenantSettingsContract, + KeyName = "settingsType", + SegmentName = "settings", + NamePattern = "", + Type = SettingsTypeName + >; +} + +@armResourceOperations +interface TenantSettingsContracts { + /** + * Get tenant settings. + */ + #deprecated "deprecated" + get is ArmResourceRead< + TenantSettingsContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Public settings. + */ + #deprecated "deprecated" + listByService is ArmResourceListByParent< + TenantSettingsContract, + Parameters = { + /** + * Not used + */ + @query("$filter") + $filter?: string; + }, + Response = ArmResponse + >; +} + +@@doc(TenantSettingsContract.name, "The identifier of the settings."); +@@doc(TenantSettingsContract.properties, + "TenantSettings entity contract properties." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/UserContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/UserContract.tsp new file mode 100644 index 000000000000..017a7414685a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/UserContract.tsp @@ -0,0 +1,309 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * User details. + */ +@parentResource(ApiManagementServiceResource) +model UserContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = UserContract, + KeyName = "userId", + SegmentName = "users", + NamePattern = "" + >; +} + +@armResourceOperations +interface UserContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + }, + { + /** API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. */ + @path + @segment("users") + @key + @minLength(1) + @maxLength(80) + userId: string, + } + > {} + +@armResourceOperations +interface UserContracts { + /** + * Gets the details of the user specified by its identifier. + */ + get is ArmResourceRead< + UserContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the user specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + UserContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates or Updates a user. + */ + createOrUpdate is UserContractOps.CreateOrUpdateSync< + UserContract, + Request = UserCreateParameters, + Parameters = { + /** + * Send an Email notification to the User. + */ + @query("notify") + notify?: boolean; + + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the user specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + UserContract, + PatchModel = UserUpdateParameters, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes specific user. + */ + delete is ArmResourceDeleteWithoutOkAsync< + UserContract, + Parameters = { + /** + * Whether to delete user's subscription or not. + */ + @query("deleteSubscriptions") + deleteSubscriptions?: boolean; + + /** + * Send an Account Closed Email notification to the User. + */ + @query("notify") + notify?: boolean; + + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + + /** + * Determines the type of application which send the create user request. Default is legacy publisher portal. + */ + @query("appType") + appType?: AppType; + }, + Response = ArmAcceptedLroResponse> | NoContentResponse + >; + + /** + * Lists a collection of registered users in the specified service instance. + */ + listByService is ArmResourceListByParent< + UserContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| groups | expand | | |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + + /** + * Detailed Group in response. + */ + @query("expandGroups") + expandGroups?: boolean; + }, + Response = ArmResponse + >; + + /** + * Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal. + */ + generateSsoUrl is ArmResourceActionSync< + UserContract, + void, + ArmResponse + >; + + /** + * Gets the Shared Access Authorization Token for the User. + */ + @action("token") + getSharedAccessToken is ArmResourceActionSync< + UserContract, + UserTokenParameters, + ArmResponse + >; + + /** + * Lists all user groups. + */ + @get + @action("groups") + @list + list is ArmResourceActionSync< + UserContract, + void, + ArmResponse, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|------------------------|-----------------------------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + } + >; + + /** + * List of all user identities. + */ + @get + @action("identities") + @list + userIdentitiesList is ArmResourceActionSync< + UserContract, + void, + ArmResponse + >; + + /** + * Sends confirmation + */ + @action("confirmations/password/send") + send is ArmResourceActionSync< + UserContract, + void, + NoContentResponse, + Parameters = { + /** + * Determines the type of application which send the create user request. Default is legacy publisher portal. + */ + @query("appType") + appType?: AppType; + } + >; +} + +@@maxLength(UserContract.name, 80); +@@minLength(UserContract.name, 1); +@@doc(UserContract.name, + "User identifier. Must be unique in the current API Management service instance." +); +@@doc(UserContract.properties, "User entity contract properties."); +@@doc(UserContracts.createOrUpdate::parameters.resource, + "Create or update parameters." +); +@@doc(UserContracts.update::parameters.properties, "Update parameters."); +@@doc(UserContracts.getSharedAccessToken::parameters.body, + "Create Authorization Token parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/WikiContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/WikiContract.tsp new file mode 100644 index 000000000000..2b44ee7aaed2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/WikiContract.tsp @@ -0,0 +1,366 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiContract.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Wiki properties + */ +@singleton("default") +@parentResource(ApiContract) +model WikiContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = WikiContract, + KeyName = "wiki", + SegmentName = "wikis", + NamePattern = "" + >; +} + +@armResourceOperations +interface WikiContractOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** API identifier. Must be unique in the current API Management service instance. */ + @path + @segment("apis") + @key + @minLength(1) + @maxLength(80) + apiId: string, + }, + { + /** undefined */ + @path + @segment("wikis") + @key + default: "default", + } + > {} + +@armResourceOperations +interface WikiContracts { + /** + * Gets the details of the Wiki for an API specified by its identifier. + */ + get is WikiContractOps.Read< + WikiContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + eTag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Wiki for an API specified by its identifier. + */ + getEntityTag is WikiContractOps.CheckExistence< + WikiContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + eTag: string; + } + >; + + /** + * Creates a new Wiki for an API or updates an existing one. + */ + createOrUpdate is WikiContractOps.CreateOrUpdateSync< + WikiContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + eTag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + eTag: string; + }) + >; + + /** + * Updates the details of the Wiki for an API specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is WikiContractOps.CustomPatchSync< + WikiContract, + PatchModel = WikiUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + eTag: string; + } + >; + + /** + * Deletes the specified Wiki from an API. + */ + delete is WikiContractOps.DeleteSync< + WikiContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = OkResponse | NoContentResponse + >; + + /** + * Gets the wikis for an API specified by its identifier. + */ + list is WikiContractOps.List< + WikiContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} +@armResourceOperations +interface ProductWikiOps + extends Azure.ResourceManager.Legacy.LegacyOperations< + { + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + ...Azure.ResourceManager.Legacy.Provider, + + /** The name of the API Management service. */ + @path + @segment("service") + @key + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @minLength(1) + @maxLength(50) + serviceName: string, + + /** Product identifier. Must be unique in the current API Management service instance. */ + @path + @segment("products") + @key + @minLength(1) + @maxLength(256) + productId: string, + }, + { + /** undefined */ + @path + @segment("wikis") + @key + default: "default", + } + > {} + +@armResourceOperations +interface ProductWiki { + /** + * Gets the details of the Wiki for a Product specified by its identifier. + */ + get is ProductWikiOps.Read< + WikiContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + eTag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the Wiki for a Product specified by its identifier. + */ + getEntityTag is ProductWikiOps.CheckExistence< + WikiContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + eTag: string; + } + >; + + /** + * Creates a new Wiki for a Product or updates an existing one. + */ + createOrUpdate is ProductWikiOps.CreateOrUpdateSync< + WikiContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + eTag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + eTag: string; + }) + >; + + /** + * Updates the details of the Wiki for a Product specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is ProductWikiOps.CustomPatchSync< + WikiContract, + PatchModel = WikiUpdateContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + eTag: string; + } + >; + + /** + * Deletes the specified Wiki from a Product. + */ + delete is ProductWikiOps.DeleteSync< + WikiContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Gets the details of the Wiki for a Product specified by its identifier. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @operationId("ProductWikis_list") + list is ProductWikiOps.List< + WikiContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; +} + +@@doc(WikiContract.name, ""); +@@doc(WikiContract.properties, "Wiki details."); +@@doc(WikiContracts.createOrUpdate::parameters.resource, "Create parameters."); +@@doc(WikiContracts.update::parameters.properties, "Wiki Update parameters."); +@@doc(ProductWiki.createOrUpdate::parameters.resource, "Create parameters."); +@@doc(ProductWiki.update::parameters.properties, "Wiki Update parameters."); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/WorkspaceContract.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/WorkspaceContract.tsp new file mode 100644 index 000000000000..f9855083da99 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/WorkspaceContract.tsp @@ -0,0 +1,166 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./ApiManagementServiceResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; +/** + * Workspace details. + */ +@parentResource(ApiManagementServiceResource) +model WorkspaceContract + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = WorkspaceContract, + KeyName = "workspaceId", + SegmentName = "workspaces", + NamePattern = "^[^*#&+:<>?]+$" + >; +} + +@armResourceOperations +interface WorkspaceContracts { + /** + * Gets the details of the workspace specified by its identifier. + */ + get is ArmResourceRead< + WorkspaceContract, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Gets the entity state (Etag) version of the workspace specified by its identifier. + */ + getEntityTag is ArmResourceCheckExistence< + WorkspaceContract, + Response = OkResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Creates a new workspace or updates an existing one. + */ + createOrUpdate is ArmResourceCreateOrReplaceSync< + WorkspaceContract, + Parameters = { + /** + * ETag of the Entity. Not required when creating an entity, but required when updating an entity. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`?: string; + }, + Response = (ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) | (ArmCreatedResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + }) + >; + + /** + * Updates the details of the workspace specified by its identifier. + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync< + WorkspaceContract, + PatchModel = WorkspaceContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + }, + Response = ArmResponse & { + /** + * Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. + */ + @header("ETag") + etag: string; + } + >; + + /** + * Deletes the specified workspace. + */ + delete is ArmResourceDeleteSync< + WorkspaceContract, + Parameters = { + /** + * ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @header("If-Match") + `If-Match`: string; + } + >; + + /** + * Lists all workspaces of the API Management service instance. + */ + listByService is ArmResourceListByParent< + WorkspaceContract, + Parameters = { + /** + * | Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
+ */ + @query("$filter") + $filter?: string; + + /** + * Number of records to return. + */ + @minValue(1) + @query("$top") + $top?: int32; + + /** + * Number of records to skip. + */ + @minValue(0) + @query("$skip") + $skip?: int32; + }, + Response = ArmResponse + >; +} + +@@maxLength(WorkspaceContract.name, 80); +@@minLength(WorkspaceContract.name, 1); +@@doc(WorkspaceContract.name, + "Workspace identifier. Must be unique in the current API Management service instance." +); +@@doc(WorkspaceContract.properties, "Workspace entity contract properties."); +@@doc(WorkspaceContracts.createOrUpdate::parameters.resource, + "Create parameters." +); +@@doc(WorkspaceContracts.update::parameters.properties, + "Workspace Update parameters." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/back-compatible.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/back-compatible.tsp new file mode 100644 index 000000000000..4510a08dc56d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/back-compatible.tsp @@ -0,0 +1,1522 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using Microsoft.ApiManagement; + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiManagementGatewayUpdateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AllPoliciesContract.properties +); + +@@clientName(ApiEntityBaseContract.type, "ApiType"); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiCreateOrUpdateParameter.properties +); + +@@clientName(ApiCreateOrUpdateProperties.apiType, "SoapApiType"); +@@clientName(ApiCreateOrUpdateProperties.translateRequiredQueryParameters, + "TranslateRequiredQueryParametersConduct" +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiUpdateContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(OperationUpdateContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ResolverUpdateContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SchemaContractProperties.document +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(IssueUpdateContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TagDescriptionCreateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(WikiUpdateContract.properties +); + +@@clientName(ApiExportResult.format, "ExportResultFormat"); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiVersionSetUpdateParameters.properties +); + +@@clientName(AuthorizationContractProperties.oauth2grantType, + "OAuth2GrantType" +); + +@@clientName(AuthorizationContractProperties.authorizationType, + "AuthorizationType" +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AuthorizationServerUpdateContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(BackendUpdateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(BackendReconnectContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CacheUpdateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CertificateCreateOrUpdateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Operation.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(RemotePrivateEndpointConnectionWrapper.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiManagementServiceUpdateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DocumentationUpdateContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(EmailTemplateUpdateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AssociationContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GroupCreateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GroupUpdateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(IdentityProviderCreateContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(IdentityProviderUpdateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(LoggerUpdateContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(NamedValueCreateContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(NamedValueUpdateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(RecipientUserContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(RecipientEmailContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(OpenidConnectProviderUpdateContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PolicyDescriptionContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PolicyRestrictionUpdateContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(OperationResultContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PortalSettingsContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ProductUpdateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(QuotaCounterValueUpdateContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GlobalSchemaContractProperties.document +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SubscriptionCreateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SubscriptionUpdateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TagCreateUpdateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AccessInformationCreateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AccessInformationUpdateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DeployConfigurationParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SaveConfigurationParameter.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TenantConfigurationSyncStateContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(UserCreateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(UserUpdateParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(UserTokenParameters.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DiagnosticUpdateContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PolicyWithComplianceContract.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(QuotaCounterValueContract.value +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ResolverResultContract.properties +); + +@@clientLocation(ApiManagementGatewayResources.get, "ApiGateway"); +@@clientLocation(ApiManagementGatewayResources.createOrUpdate, "ApiGateway"); +@@clientName(ApiManagementGatewayResources.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(ApiManagementGatewayResources.update, "ApiGateway"); +@@clientName(ApiManagementGatewayResources.update::parameters.properties, + "parameters" +); +@@clientLocation(ApiManagementGatewayResources.delete, "ApiGateway"); +@@clientLocation(ApiManagementGatewayResources.listByResourceGroup, + "ApiGateway" +); +@@clientLocation(ApiManagementGatewayResources.list, "ApiGateway"); +@@clientLocation(ApiManagementGatewayResources.listAvailableSkus, + "ApiManagementGatewaySkus" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiManagementGatewayResource.properties +); + +@@clientLocation(ApiContracts.get, "Api"); +@@clientLocation(ApiContracts.getEntityTag, "Api"); +@@clientLocation(ApiContracts.createOrUpdate, "Api"); +@@clientName(ApiContracts.createOrUpdate::parameters.resource, "parameters"); +@@clientLocation(ApiContracts.update, "Api"); +@@clientName(ApiContracts.update::parameters.properties, "parameters"); +@@clientLocation(ApiContracts.delete, "Api"); +@@clientLocation(ApiContracts.listByService, "Api"); +@@clientLocation(ApiContracts.apiRevisionListByService, "ApiRevision"); +@@clientName(ApiContracts.apiRevisionListByService, "ListByService"); +@@clientLocation(ApiContracts.listByApis, "ApiProduct"); +@@clientLocation(ApiContracts.listByTags, "Operation"); +@@clientName(WorkspaceApi.createOrUpdate::parameters.resource, "parameters"); +@@clientName(WorkspaceApi.update::parameters.properties, "parameters"); +@@clientLocation(WorkspaceApi.workspaceApiRevisionListByService, + "WorkspaceApiRevision" +); +@@clientName(WorkspaceApi.workspaceApiRevisionListByService, "ListByService"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiContract.properties); + +@@clientLocation(ApiReleaseContracts.get, "ApiRelease"); +@@clientLocation(ApiReleaseContracts.getEntityTag, "ApiRelease"); +@@clientLocation(ApiReleaseContracts.createOrUpdate, "ApiRelease"); +@@clientName(ApiReleaseContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(ApiReleaseContracts.update, "ApiRelease"); +@@clientName(ApiReleaseContracts.update::parameters.properties, "parameters"); +@@clientLocation(ApiReleaseContracts.delete, "ApiRelease"); +@@clientLocation(ApiReleaseContracts.listByService, "ApiRelease"); +@@clientName(WorkspaceApiRelease.createOrUpdate::parameters.resource, + "parameters" +); +@@clientName(WorkspaceApiRelease.update::parameters.properties, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiReleaseContract.properties +); + +@@clientLocation(OperationContracts.get, "ApiOperation"); +@@clientLocation(OperationContracts.getEntityTag, "ApiOperation"); +@@clientLocation(OperationContracts.createOrUpdate, "ApiOperation"); +@@clientName(OperationContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(OperationContracts.update, "ApiOperation"); +@@clientName(OperationContracts.update::parameters.properties, "parameters"); +@@clientLocation(OperationContracts.delete, "ApiOperation"); +@@clientLocation(OperationContracts.listByApi, "ApiOperation"); +@@clientName(WorkspaceApiOperation.createOrUpdate::parameters.resource, + "parameters" +); +@@clientName(WorkspaceApiOperation.update::parameters.properties, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(OperationContract.properties +); + +@@clientLocation(PolicyContracts.get, "ApiOperationPolicy"); +@@clientLocation(PolicyContracts.getEntityTag, "ApiOperationPolicy"); +@@clientLocation(PolicyContracts.createOrUpdate, "ApiOperationPolicy"); +@@clientName(PolicyContracts.createOrUpdate::parameters.resource, "parameters"); +@@clientLocation(PolicyContracts.delete, "ApiOperationPolicy"); +@@clientLocation(PolicyContracts.listByOperation, "ApiOperationPolicy"); +@@clientName(GraphQLApiResolverPolicy.createOrUpdate::parameters.resource, + "parameters" +); +@@clientName(ApiPolicy.createOrUpdate::parameters.resource, "parameters"); +@@clientName(Policy.createOrUpdate::parameters.resource, "parameters"); +@@clientName(ProductPolicy.createOrUpdate::parameters.resource, "parameters"); +@@clientName(WorkspacePolicy.createOrUpdate::parameters.resource, "parameters"); +@@clientName(WorkspaceApiOperationPolicy.createOrUpdate::parameters.resource, + "parameters" +); +@@clientName(WorkspaceApiPolicy.createOrUpdate::parameters.resource, + "parameters" +); +@@clientName(WorkspaceProductPolicy.createOrUpdate::parameters.resource, + "parameters" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PolicyContract.properties); + +@@clientLocation(TagContracts.getByOperation, Tag); +@@clientLocation(TagContracts.getEntityStateByOperation, Tag); +@@clientLocation(TagContracts.assignToOperation, Tag); +@@clientLocation(TagContracts.detachFromOperation, Tag); +@@clientLocation(TagContracts.listByOperation, Tag); +@@clientLocation(TagContractOperation.getByProduct, Tag); +@@clientLocation(TagContractOperation.getEntityStateByProduct, Tag); +@@clientLocation(TagContractOperation.assignToProduct, Tag); +@@clientLocation(TagContractOperation.detachFromProduct, Tag); +@@clientLocation(TagContractOperation.listByProduct, Tag); +@@clientLocation(TagContractOperationGroup.get, Tag); +@@clientLocation(TagContractOperationGroup.getEntityState, Tag); +@@clientLocation(TagContractOperationGroup.createOrUpdate, Tag); +@@clientName(TagContractOperationGroup.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(TagContractOperationGroup.update, Tag); +@@clientName(TagContractOperationGroup.update::parameters.properties, + "parameters" +); +@@clientLocation(TagContractOperationGroup.delete, Tag); +@@clientLocation(TagContractOperationGroup.listByService, Tag); +@@clientName(WorkspaceTag.createOrUpdate::parameters.resource, "parameters"); +@@clientName(WorkspaceTag.update::parameters.properties, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TagContract.properties); + +@@clientLocation(ResolverContracts.get, "GraphQLApiResolver"); +@@clientLocation(ResolverContracts.getEntityTag, "GraphQLApiResolver"); +@@clientLocation(ResolverContracts.createOrUpdate, "GraphQLApiResolver"); +@@clientName(ResolverContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(ResolverContracts.update, "GraphQLApiResolver"); +@@clientName(ResolverContracts.update::parameters.properties, "parameters"); +@@clientLocation(ResolverContracts.delete, "GraphQLApiResolver"); +@@clientLocation(ResolverContracts.listByApi, "GraphQLApiResolver"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ResolverContract.properties +); + +@@clientLocation(ProductContracts.get, "Product"); +@@clientLocation(ProductContracts.getEntityTag, "Product"); +@@clientLocation(ProductContracts.createOrUpdate, "Product"); +@@clientName(ProductContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(ProductContracts.update, "Product"); +@@clientName(ProductContracts.update::parameters.properties, "parameters"); +@@clientLocation(ProductContracts.delete, "Product"); +@@clientLocation(ProductContracts.listByService, "Product"); +@@clientLocation(ProductContracts.listByProduct, "ProductApi"); +@@clientLocation(ProductContracts.checkEntityExists, "ProductApi"); +@@clientLocation(ProductContracts.productApiCreateOrUpdate, "ProductApi"); +@@clientName(ProductContracts.productApiCreateOrUpdate, "CreateOrUpdate"); +@@clientLocation(ProductContracts.productApiDelete, "ProductApi"); +@@clientName(ProductContracts.productApiDelete, "Delete"); +@@clientLocation(ProductContracts.productGroupListByProduct, "ProductGroup"); +@@clientName(ProductContracts.productGroupListByProduct, "ListByProduct"); +@@clientLocation(ProductContracts.productGroupCheckEntityExists, + "ProductGroup" +); +@@clientName(ProductContracts.productGroupCheckEntityExists, + "CheckEntityExists" +); +@@clientLocation(ProductContracts.productGroupCreateOrUpdate, "ProductGroup"); +@@clientName(ProductContracts.productGroupCreateOrUpdate, "CreateOrUpdate"); +@@clientLocation(ProductContracts.productGroupDelete, "ProductGroup"); +@@clientName(ProductContracts.productGroupDelete, "Delete"); +@@clientLocation(ProductContracts.list, "ProductSubscriptions"); +@@clientName(WorkspaceProduct.createOrUpdate::parameters.resource, + "parameters" +); +@@clientName(WorkspaceProduct.update::parameters.properties, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ProductContract.properties); + +@@clientLocation(SchemaContracts.get, "ApiSchema"); +@@clientLocation(SchemaContracts.getEntityTag, "ApiSchema"); +@@clientLocation(SchemaContracts.createOrUpdate, "ApiSchema"); +@@clientName(SchemaContracts.createOrUpdate::parameters.resource, "parameters"); +@@clientLocation(SchemaContracts.delete, "ApiSchema"); +@@clientLocation(SchemaContracts.listByApi, "ApiSchema"); +@@clientName(WorkspaceApiSchema.createOrUpdate::parameters.resource, + "parameters" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SchemaContract.properties); + +@@clientLocation(DiagnosticContracts.get, "ApiDiagnostic"); +@@clientLocation(DiagnosticContracts.getEntityTag, "ApiDiagnostic"); +@@clientLocation(DiagnosticContracts.createOrUpdate, "ApiDiagnostic"); +@@clientName(DiagnosticContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(DiagnosticContracts.update, "ApiDiagnostic"); +@@clientName(DiagnosticContracts.update::parameters.properties, "parameters"); +@@clientLocation(DiagnosticContracts.delete, "ApiDiagnostic"); +@@clientLocation(DiagnosticContracts.listByService, "ApiDiagnostic"); +@@clientName(Diagnostic.createOrUpdate::parameters.resource, "parameters"); +@@clientName(Diagnostic.update::parameters.properties, "parameters"); +@@clientName(WorkspaceDiagnostic.createOrUpdate::parameters.resource, + "parameters" +); +@@clientName(WorkspaceDiagnostic.update::parameters.properties, "parameters"); +@@clientName(WorkspaceApiDiagnostic.createOrUpdate::parameters.resource, + "parameters" +); +@@clientName(WorkspaceApiDiagnostic.update::parameters.properties, + "parameters" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DiagnosticContract.properties +); + +@@clientLocation(IssueContracts.get, "ApiIssue"); +@@clientLocation(IssueContracts.getEntityTag, "ApiIssue"); +@@clientLocation(IssueContracts.createOrUpdate, "ApiIssue"); +@@clientName(IssueContracts.createOrUpdate::parameters.resource, "parameters"); +@@clientLocation(IssueContracts.update, "ApiIssue"); +@@clientName(IssueContracts.update::parameters.properties, "parameters"); +@@clientLocation(IssueContracts.delete, "ApiIssue"); +@@clientLocation(IssueContracts.listByService, "ApiIssue"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(IssueContract.properties); + +@@clientLocation(IssueCommentContracts.get, "ApiIssueComment"); +@@clientLocation(IssueCommentContracts.getEntityTag, "ApiIssueComment"); +@@clientLocation(IssueCommentContracts.createOrUpdate, "ApiIssueComment"); +@@clientName(IssueCommentContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(IssueCommentContracts.delete, "ApiIssueComment"); +@@clientLocation(IssueCommentContracts.listByService, "ApiIssueComment"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(IssueCommentContract.properties +); + +@@clientLocation(IssueAttachmentContracts.get, "ApiIssueAttachment"); +@@clientLocation(IssueAttachmentContracts.getEntityTag, "ApiIssueAttachment"); +@@clientLocation(IssueAttachmentContracts.createOrUpdate, "ApiIssueAttachment"); +@@clientName(IssueAttachmentContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(IssueAttachmentContracts.delete, "ApiIssueAttachment"); +@@clientLocation(IssueAttachmentContracts.listByService, "ApiIssueAttachment"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(IssueAttachmentContract.properties +); + +@@clientLocation(TagDescriptionContracts.get, "ApiTagDescription"); +@@clientLocation(TagDescriptionContracts.getEntityTag, "ApiTagDescription"); +@@clientLocation(TagDescriptionContracts.createOrUpdate, "ApiTagDescription"); +@@clientName(TagDescriptionContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(TagDescriptionContracts.delete, "ApiTagDescription"); +@@clientLocation(TagDescriptionContracts.listByService, "ApiTagDescription"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TagDescriptionContract.properties +); + +@@clientLocation(WikiContracts.get, "ApiWiki"); +@@clientLocation(WikiContracts.getEntityTag, "ApiWiki"); +@@clientLocation(WikiContracts.createOrUpdate, "ApiWiki"); +@@clientName(WikiContracts.createOrUpdate::parameters.resource, "parameters"); +@@clientLocation(WikiContracts.update, "ApiWiki"); +@@clientName(WikiContracts.update::parameters.properties, "parameters"); +@@clientLocation(WikiContracts.delete, "ApiWiki"); +@@clientLocation(WikiContracts.list, "ApiWikis"); +@@clientName(ProductWiki.createOrUpdate::parameters.resource, "parameters"); +@@clientName(ProductWiki.update::parameters.properties, "parameters"); +@@clientLocation(ProductWiki.list, "ProductWikis"); +@@clientName(ProductWiki.list, "list"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(WikiContract.properties); + +@@clientLocation(ApiVersionSetContracts.get, "ApiVersionSet"); +@@clientLocation(ApiVersionSetContracts.getEntityTag, "ApiVersionSet"); +@@clientLocation(ApiVersionSetContracts.createOrUpdate, "ApiVersionSet"); +@@clientName(ApiVersionSetContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(ApiVersionSetContracts.update, "ApiVersionSet"); +@@clientName(ApiVersionSetContracts.update::parameters.properties, + "parameters" +); +@@clientLocation(ApiVersionSetContracts.delete, "ApiVersionSet"); +@@clientLocation(ApiVersionSetContracts.listByService, "ApiVersionSet"); +@@clientName(WorkspaceApiVersionSet.createOrUpdate::parameters.resource, + "parameters" +); +@@clientName(WorkspaceApiVersionSet.update::parameters.properties, + "parameters" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiVersionSetContract.properties +); + +@@clientLocation(AuthorizationProviderContracts.get, "AuthorizationProvider"); +@@clientLocation(AuthorizationProviderContracts.createOrUpdate, + "AuthorizationProvider" +); +@@clientName(AuthorizationProviderContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(AuthorizationProviderContracts.delete, + "AuthorizationProvider" +); +@@clientLocation(AuthorizationProviderContracts.listByService, + "AuthorizationProvider" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AuthorizationProviderContract.properties +); + +@@clientLocation(AuthorizationContracts.get, "Authorization"); +@@clientLocation(AuthorizationContracts.createOrUpdate, "Authorization"); +@@clientName(AuthorizationContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(AuthorizationContracts.delete, "Authorization"); +@@clientLocation(AuthorizationContracts.listByAuthorizationProvider, + "Authorization" +); +@@clientLocation(AuthorizationContracts.confirmConsentCode, "Authorization"); +@@clientName(AuthorizationContracts.confirmConsentCode::parameters.body, + "parameters" +); +@@clientLocation(AuthorizationContracts.post, "AuthorizationLoginLinks"); +@@clientName(AuthorizationContracts.post::parameters.body, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AuthorizationContract.properties +); + +@@clientLocation(AuthorizationAccessPolicyContracts.get, + "AuthorizationAccessPolicy" +); +@@clientLocation(AuthorizationAccessPolicyContracts.createOrUpdate, + "AuthorizationAccessPolicy" +); +@@clientName(AuthorizationAccessPolicyContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(AuthorizationAccessPolicyContracts.delete, + "AuthorizationAccessPolicy" +); +@@clientLocation(AuthorizationAccessPolicyContracts.listByAuthorization, + "AuthorizationAccessPolicy" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AuthorizationAccessPolicyContract.properties +); + +@@clientLocation(AuthorizationServerContracts.get, "AuthorizationServer"); +@@clientLocation(AuthorizationServerContracts.getEntityTag, + "AuthorizationServer" +); +@@clientLocation(AuthorizationServerContracts.createOrUpdate, + "AuthorizationServer" +); +@@clientName(AuthorizationServerContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(AuthorizationServerContracts.update, "AuthorizationServer"); +@@clientName(AuthorizationServerContracts.update::parameters.properties, + "parameters" +); +@@clientLocation(AuthorizationServerContracts.delete, "AuthorizationServer"); +@@clientLocation(AuthorizationServerContracts.listByService, + "AuthorizationServer" +); +@@clientLocation(AuthorizationServerContracts.listSecrets, + "AuthorizationServer" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AuthorizationServerContract.properties +); + +@@clientLocation(BackendContracts.get, "Backend"); +@@clientLocation(BackendContracts.getEntityTag, "Backend"); +@@clientLocation(BackendContracts.createOrUpdate, "Backend"); +@@clientName(BackendContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(BackendContracts.update, "Backend"); +@@clientName(BackendContracts.update::parameters.properties, "parameters"); +@@clientLocation(BackendContracts.delete, "Backend"); +@@clientLocation(BackendContracts.listByService, "Backend"); +@@clientLocation(BackendContracts.reconnect, "Backend"); +@@clientName(BackendContracts.reconnect::parameters.body, "parameters"); +@@clientName(WorkspaceBackend.createOrUpdate::parameters.resource, + "parameters" +); +@@clientName(WorkspaceBackend.update::parameters.properties, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(BackendContract.properties); + +@@clientLocation(CacheContracts.get, "Cache"); +@@clientLocation(CacheContracts.getEntityTag, "Cache"); +@@clientLocation(CacheContracts.createOrUpdate, "Cache"); +@@clientName(CacheContracts.createOrUpdate::parameters.resource, "parameters"); +@@clientLocation(CacheContracts.update, "Cache"); +@@clientName(CacheContracts.update::parameters.properties, "parameters"); +@@clientLocation(CacheContracts.delete, "Cache"); +@@clientLocation(CacheContracts.listByService, "Cache"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CacheContract.properties); + +@@clientLocation(CertificateContracts.get, "Certificate"); +@@clientLocation(CertificateContracts.getEntityTag, "Certificate"); +@@clientLocation(CertificateContracts.createOrUpdate, "Certificate"); +@@clientName(CertificateContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(CertificateContracts.delete, "Certificate"); +@@clientLocation(CertificateContracts.listByService, "Certificate"); +@@clientLocation(CertificateContracts.refreshSecret, "Certificate"); +@@clientName(WorkspaceCertificate.createOrUpdate::parameters.resource, + "parameters" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CertificateContract.properties +); + +@@clientLocation(ContentTypeContracts.get, "ContentType"); +@@clientLocation(ContentTypeContracts.createOrUpdate, "ContentType"); +@@clientName(ContentTypeContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(ContentTypeContracts.delete, "ContentType"); +@@clientLocation(ContentTypeContracts.listByService, "ContentType"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ContentTypeContract.properties +); + +@@clientLocation(ContentItemContracts.get, "ContentItem"); +@@clientLocation(ContentItemContracts.getEntityTag, "ContentItem"); +@@clientLocation(ContentItemContracts.createOrUpdate, "ContentItem"); +@@clientName(ContentItemContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(ContentItemContracts.delete, "ContentItem"); +@@clientLocation(ContentItemContracts.listByService, "ContentItem"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ContentItemContract.properties +); + +@@clientLocation(DeletedServiceContracts.getByName, "DeletedServices"); +@@clientLocation(DeletedServiceContracts.purge, "DeletedServices"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DeletedServiceContract.properties +); + +@@clientLocation(ApiManagementServiceResources.get, "ApiManagementService"); +@@clientLocation(ApiManagementServiceResources.createOrUpdate, + "ApiManagementService" +); +@@clientName(ApiManagementServiceResources.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(ApiManagementServiceResources.update, "ApiManagementService"); +@@clientName(ApiManagementServiceResources.update::parameters.properties, + "parameters" +); +@@clientLocation(ApiManagementServiceResources.delete, "ApiManagementService"); +@@clientLocation(ApiManagementServiceResources.listByResourceGroup, + "ApiManagementService" +); +@@clientLocation(ApiManagementServiceResources.list, "ApiManagementService"); +@@clientLocation(ApiManagementServiceResources.listByService, "AllPolicies"); +@@clientLocation(ApiManagementServiceResources.listByTags, "Api"); +@@clientLocation(ApiManagementServiceResources.performConnectivityCheckAsync, + "" +); +@@clientName(ApiManagementServiceResources.performConnectivityCheckAsync::parameters.body, + "connectivityCheckRequestParams" +); +@@clientLocation(ApiManagementServiceResources.listAvailableServiceSkus, + "ApiManagementServiceSkus" +); +@@clientLocation(ApiManagementServiceResources.restore, "ApiManagementService"); +@@clientName(ApiManagementServiceResources.restore::parameters.body, + "parameters" +); +@@clientLocation(ApiManagementServiceResources.backup, "ApiManagementService"); +@@clientName(ApiManagementServiceResources.backup::parameters.body, + "parameters" +); +@@clientLocation(ApiManagementServiceResources.migrateToStv2, + "ApiManagementService" +); +@@clientName(ApiManagementServiceResources.migrateToStv2::parameters.body, + "parameters" +); +@@clientLocation(ApiManagementServiceResources.getSsoToken, + "ApiManagementService" +); +@@clientLocation(ApiManagementServiceResources.applyNetworkConfigurationUpdates, + "ApiManagementService" +); +@@clientName(ApiManagementServiceResources.applyNetworkConfigurationUpdates::parameters.body, + "parameters" +); +@@clientLocation(ApiManagementServiceResources.networkStatusListByService, + "NetworkStatus" +); +@@clientName(ApiManagementServiceResources.networkStatusListByService, + "ListByService" +); +@@clientLocation(ApiManagementServiceResources.listByLocation, "NetworkStatus"); +@@clientLocation(ApiManagementServiceResources.outboundNetworkDependenciesEndpointsListByService, + "OutboundNetworkDependenciesEndpoints" +); +@@clientName(ApiManagementServiceResources.outboundNetworkDependenciesEndpointsListByService, + "ListByService" +); +@@clientLocation(ApiManagementServiceResources.policyDescriptionListByService, + "PolicyDescription" +); +@@clientName(ApiManagementServiceResources.policyDescriptionListByService, + "ListByService" +); +@@clientLocation(ApiManagementServiceResources.byService, + "PolicyRestrictionValidations" +); +@@clientLocation(ApiManagementServiceResources.portalSettingsListByService, + "PortalSettings" +); +@@clientName(ApiManagementServiceResources.portalSettingsListByService, + "ListByService" +); +@@clientLocation(ApiManagementServiceResources.productListByTags, "Product"); +@@clientName(ApiManagementServiceResources.productListByTags, "ListByTags"); +@@clientLocation(ApiManagementServiceResources.quotaByCounterKeysListByService, + "QuotaByCounterKeys" +); +@@clientName(ApiManagementServiceResources.quotaByCounterKeysListByService, + "ListByService" +); +@@clientLocation(ApiManagementServiceResources.quotaByCounterKeysUpdate, + "QuotaByCounterKeys" +); +@@clientName(ApiManagementServiceResources.quotaByCounterKeysUpdate, "Update"); + +@@clientLocation(ApiManagementServiceResources.quotaByPeriodKeysGet, + "QuotaByPeriodKeys" +); +@@clientName(ApiManagementServiceResources.quotaByPeriodKeysGet, "Get"); +@@clientLocation(ApiManagementServiceResources.quotaByPeriodKeysUpdate, + "QuotaByPeriodKeys" +); +@@clientName(ApiManagementServiceResources.quotaByPeriodKeysUpdate, "Update"); +@@clientName(ApiManagementServiceResources.quotaByPeriodKeysUpdate::parameters.body, + "parameters" +); +@@clientLocation(ApiManagementServiceResources.regionListByService, "Region"); +@@clientName(ApiManagementServiceResources.regionListByService, + "ListByService" +); +@@clientLocation(ApiManagementServiceResources.listByApi, "Reports"); +@@clientLocation(ApiManagementServiceResources.listByUser, "Reports"); +@@clientLocation(ApiManagementServiceResources.listByOperation, "Reports"); +@@clientLocation(ApiManagementServiceResources.listByProduct, "Reports"); +@@clientLocation(ApiManagementServiceResources.listByGeo, "Reports"); +@@clientLocation(ApiManagementServiceResources.listBySubscription, "Reports"); +@@clientLocation(ApiManagementServiceResources.listByTime, "Reports"); +@@clientLocation(ApiManagementServiceResources.listByRequest, "Reports"); +@@clientLocation(ApiManagementServiceResources.tagResourceListByService, + "TagResource" +); +@@clientName(ApiManagementServiceResources.tagResourceListByService, + "ListByService" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiManagementServiceResource.properties +); + +@@clientLocation(DocumentationContracts.get, "Documentation"); +@@clientLocation(DocumentationContracts.getEntityTag, "Documentation"); +@@clientLocation(DocumentationContracts.createOrUpdate, "Documentation"); +@@clientName(DocumentationContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(DocumentationContracts.update, "Documentation"); +@@clientName(DocumentationContracts.update::parameters.properties, + "parameters" +); +@@clientLocation(DocumentationContracts.delete, "Documentation"); +@@clientLocation(DocumentationContracts.listByService, "Documentation"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DocumentationContract.properties +); + +@@clientLocation(EmailTemplateContracts.get, "EmailTemplate"); +@@clientLocation(EmailTemplateContracts.getEntityTag, "EmailTemplate"); +@@clientLocation(EmailTemplateContracts.createOrUpdate, "EmailTemplate"); +@@clientName(EmailTemplateContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(EmailTemplateContracts.update, "EmailTemplate"); +@@clientName(EmailTemplateContracts.update::parameters.properties, + "parameters" +); +@@clientLocation(EmailTemplateContracts.delete, "EmailTemplate"); +@@clientLocation(EmailTemplateContracts.listByService, "EmailTemplate"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(EmailTemplateContract.properties +); + +@@clientLocation(ApiManagementGatewayConfigConnectionResources.get, + "ApiGatewayConfigConnection" +); +@@clientLocation(ApiManagementGatewayConfigConnectionResources.createOrUpdate, + "ApiGatewayConfigConnection" +); +@@clientName(ApiManagementGatewayConfigConnectionResources.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(ApiManagementGatewayConfigConnectionResources.delete, + "ApiGatewayConfigConnection" +); +@@clientLocation(ApiManagementGatewayConfigConnectionResources.listByGateway, + "ApiGatewayConfigConnection" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiManagementGatewayConfigConnectionResource.properties +); + +@@clientLocation(GatewayContracts.get, "Gateway"); +@@clientLocation(GatewayContracts.getEntityTag, "Gateway"); +@@clientLocation(GatewayContracts.createOrUpdate, "Gateway"); +@@clientName(GatewayContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(GatewayContracts.update, "Gateway"); +@@clientName(GatewayContracts.update::parameters.properties, "parameters"); +@@clientLocation(GatewayContracts.delete, "Gateway"); +@@clientLocation(GatewayContracts.listByService, "Gateway"); +@@clientLocation(GatewayContracts.listKeys, "Gateway"); +@@clientLocation(GatewayContracts.regenerateKey, "Gateway"); +@@clientName(GatewayContracts.regenerateKey::parameters.body, "parameters"); +@@clientLocation(GatewayContracts.generateToken, "Gateway"); +@@clientName(GatewayContracts.generateToken::parameters.body, "parameters"); +@@clientLocation(GatewayContracts.invalidateDebugCredentials, "Gateway"); +@@clientLocation(GatewayContracts.listDebugCredentials, "Gateway"); +@@clientName(GatewayContracts.listDebugCredentials::parameters.body, + "parameters" +); +@@clientLocation(GatewayContracts.listTrace, "Gateway"); +@@clientName(GatewayContracts.listTrace::parameters.body, "parameters"); +@@clientLocation(GatewayContracts.gatewayApiListByService, "GatewayApi"); +@@clientName(GatewayContracts.gatewayApiListByService, "ListByService"); +@@clientLocation(GatewayContracts.gatewayApiGetEntityTag, "GatewayApi"); +@@clientName(GatewayContracts.gatewayApiGetEntityTag, "GetEntityTag"); +@@clientLocation(GatewayContracts.gatewayApiCreateOrUpdate, "GatewayApi"); +@@clientName(GatewayContracts.gatewayApiCreateOrUpdate, "CreateOrUpdate"); +@@clientName(GatewayContracts.gatewayApiCreateOrUpdate::parameters.body, + "parameters" +); +@@clientLocation(GatewayContracts.gatewayApiDelete, "GatewayApi"); +@@clientName(GatewayContracts.gatewayApiDelete, "Delete"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GatewayContract.properties); + +@@clientLocation(GatewayHostnameConfigurationContracts.get, + "GatewayHostnameConfiguration" +); +@@clientLocation(GatewayHostnameConfigurationContracts.getEntityTag, + "GatewayHostnameConfiguration" +); +@@clientLocation(GatewayHostnameConfigurationContracts.createOrUpdate, + "GatewayHostnameConfiguration" +); +@@clientName(GatewayHostnameConfigurationContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(GatewayHostnameConfigurationContracts.delete, + "GatewayHostnameConfiguration" +); +@@clientLocation(GatewayHostnameConfigurationContracts.listByService, + "GatewayHostnameConfiguration" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GatewayHostnameConfigurationContract.properties +); + +@@clientLocation(GatewayCertificateAuthorityContracts.get, + "GatewayCertificateAuthority" +); +@@clientLocation(GatewayCertificateAuthorityContracts.getEntityTag, + "GatewayCertificateAuthority" +); +@@clientLocation(GatewayCertificateAuthorityContracts.createOrUpdate, + "GatewayCertificateAuthority" +); +@@clientName(GatewayCertificateAuthorityContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(GatewayCertificateAuthorityContracts.delete, + "GatewayCertificateAuthority" +); +@@clientLocation(GatewayCertificateAuthorityContracts.listByService, + "GatewayCertificateAuthority" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GatewayCertificateAuthorityContract.properties +); + +@@clientLocation(GroupContracts.get, "Group"); +@@clientLocation(GroupContracts.getEntityTag, "Group"); +@@clientLocation(GroupContracts.createOrUpdate, "Group"); +@@clientName(GroupContracts.createOrUpdate::parameters.resource, "parameters"); +@@clientLocation(GroupContracts.update, "Group"); +@@clientName(GroupContracts.update::parameters.properties, "parameters"); +@@clientLocation(GroupContracts.delete, "Group"); +@@clientLocation(GroupContracts.listByService, "Group"); +@@clientLocation(GroupContracts.list, "GroupUser"); +@@clientLocation(GroupContracts.checkEntityExists, "GroupUser"); +@@clientLocation(GroupContracts.create, "GroupUser"); +@@clientLocation(GroupContracts.groupUserDelete, "GroupUser"); +@@clientName(GroupContracts.groupUserDelete, "Delete"); +@@clientName(WorkspaceGroup.createOrUpdate::parameters.resource, "parameters"); +@@clientName(WorkspaceGroup.update::parameters.properties, "parameters"); +@@clientLocation(WorkspaceGroup.list, "WorkspaceGroupUser"); +@@clientLocation(WorkspaceGroup.checkEntityExists, "WorkspaceGroupUser"); +@@clientLocation(WorkspaceGroup.create, "WorkspaceGroupUser"); +@@clientLocation(WorkspaceGroup.workspaceGroupUserDelete, "WorkspaceGroupUser"); +@@clientName(WorkspaceGroup.workspaceGroupUserDelete, "Delete"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GroupContract.properties); + +@@clientLocation(UserContracts.get, "User"); +@@clientLocation(UserContracts.getEntityTag, "User"); +@@clientLocation(UserContracts.createOrUpdate, "User"); +@@clientName(UserContracts.createOrUpdate::parameters.resource, "parameters"); +@@clientLocation(UserContracts.update, "User"); +@@clientName(UserContracts.update::parameters.properties, "parameters"); +@@clientLocation(UserContracts.delete, "User"); +@@clientLocation(UserContracts.listByService, "User"); +@@clientLocation(UserContracts.generateSsoUrl, "User"); +@@clientLocation(UserContracts.getSharedAccessToken, "User"); +@@clientName(UserContracts.getSharedAccessToken::parameters.body, "parameters"); +@@clientLocation(UserContracts.list, "UserGroup"); +@@clientLocation(UserContracts.userIdentitiesList, "UserIdentities"); +@@clientName(UserContracts.userIdentitiesList, "List"); +@@clientLocation(UserContracts.send, "UserConfirmationPassword"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(UserContract.properties); + +@@clientLocation(IdentityProviderContracts.get, "IdentityProvider"); +@@clientLocation(IdentityProviderContracts.getEntityTag, "IdentityProvider"); +@@clientLocation(IdentityProviderContracts.createOrUpdate, "IdentityProvider"); +@@clientName(IdentityProviderContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(IdentityProviderContracts.update, "IdentityProvider"); +@@clientName(IdentityProviderContracts.update::parameters.properties, + "parameters" +); +@@clientLocation(IdentityProviderContracts.delete, "IdentityProvider"); +@@clientLocation(IdentityProviderContracts.listByService, "IdentityProvider"); +@@clientLocation(IdentityProviderContracts.listSecrets, "IdentityProvider"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(IdentityProviderContract.properties +); + +@@clientLocation(LoggerContracts.get, "Logger"); +@@clientLocation(LoggerContracts.getEntityTag, "Logger"); +@@clientLocation(LoggerContracts.createOrUpdate, "Logger"); +@@clientName(LoggerContracts.createOrUpdate::parameters.resource, "parameters"); +@@clientLocation(LoggerContracts.update, "Logger"); +@@clientName(LoggerContracts.update::parameters.properties, "parameters"); +@@clientLocation(LoggerContracts.delete, "Logger"); +@@clientLocation(LoggerContracts.listByService, "Logger"); +@@clientName(WorkspaceLogger.createOrUpdate::parameters.resource, "parameters"); +@@clientName(WorkspaceLogger.update::parameters.properties, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(LoggerContract.properties); + +@@clientLocation(NamedValueContracts.get, "NamedValue"); +@@clientLocation(NamedValueContracts.getEntityTag, "NamedValue"); +@@clientLocation(NamedValueContracts.createOrUpdate, "NamedValue"); +@@clientName(NamedValueContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(NamedValueContracts.update, "NamedValue"); +@@clientName(NamedValueContracts.update::parameters.properties, "parameters"); +@@clientLocation(NamedValueContracts.delete, "NamedValue"); +@@clientLocation(NamedValueContracts.listByService, "NamedValue"); +@@clientLocation(NamedValueContracts.listValue, "NamedValue"); +@@clientLocation(NamedValueContracts.refreshSecret, "NamedValue"); +@@clientName(WorkspaceNamedValue.createOrUpdate::parameters.resource, + "parameters" +); +@@clientName(WorkspaceNamedValue.update::parameters.properties, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(NamedValueContract.properties +); + +@@clientLocation(NotificationContracts.get, "Notification"); +@@clientLocation(NotificationContracts.createOrUpdate, "Notification"); +@@clientLocation(NotificationContracts.listByService, "Notification"); +@@clientLocation(NotificationContracts.listByNotification, + "NotificationRecipientUser" +); +@@clientLocation(NotificationContracts.checkEntityExists, + "NotificationRecipientUser" +); +@@clientLocation(NotificationContracts.notificationRecipientUserCreateOrUpdate, + "NotificationRecipientUser" +); +@@clientName(NotificationContracts.notificationRecipientUserCreateOrUpdate, + "CreateOrUpdate" +); +@@clientLocation(NotificationContracts.delete, "NotificationRecipientUser"); +@@clientLocation(NotificationContracts.notificationRecipientEmailListByNotification, + "NotificationRecipientEmail" +); +@@clientName(NotificationContracts.notificationRecipientEmailListByNotification, + "ListByNotification" +); +@@clientLocation(NotificationContracts.notificationRecipientEmailCheckEntityExists, + "NotificationRecipientEmail" +); +@@clientName(NotificationContracts.notificationRecipientEmailCheckEntityExists, + "CheckEntityExists" +); +@@clientLocation(NotificationContracts.notificationRecipientEmailCreateOrUpdate, + "NotificationRecipientEmail" +); +@@clientName(NotificationContracts.notificationRecipientEmailCreateOrUpdate, + "CreateOrUpdate" +); +@@clientLocation(NotificationContracts.notificationRecipientEmailDelete, + "NotificationRecipientEmail" +); +@@clientName(NotificationContracts.notificationRecipientEmailDelete, "Delete"); +@@clientLocation(WorkspaceNotification.listByNotification, + "WorkspaceNotificationRecipientUser" +); +@@clientLocation(WorkspaceNotification.checkEntityExists, + "WorkspaceNotificationRecipientUser" +); +@@clientLocation(WorkspaceNotification.workspaceNotificationRecipientUserCreateOrUpdate, + "WorkspaceNotificationRecipientUser" +); +@@clientName(WorkspaceNotification.workspaceNotificationRecipientUserCreateOrUpdate, + "CreateOrUpdate" +); +@@clientLocation(WorkspaceNotification.delete, + "WorkspaceNotificationRecipientUser" +); +@@clientLocation(WorkspaceNotification.workspaceNotificationRecipientEmailListByNotification, + "WorkspaceNotificationRecipientEmail" +); +@@clientName(WorkspaceNotification.workspaceNotificationRecipientEmailListByNotification, + "ListByNotification" +); +@@clientLocation(WorkspaceNotification.workspaceNotificationRecipientEmailCheckEntityExists, + "WorkspaceNotificationRecipientEmail" +); +@@clientName(WorkspaceNotification.workspaceNotificationRecipientEmailCheckEntityExists, + "CheckEntityExists" +); +@@clientLocation(WorkspaceNotification.workspaceNotificationRecipientEmailCreateOrUpdate, + "WorkspaceNotificationRecipientEmail" +); +@@clientName(WorkspaceNotification.workspaceNotificationRecipientEmailCreateOrUpdate, + "CreateOrUpdate" +); +@@clientLocation(WorkspaceNotification.workspaceNotificationRecipientEmailDelete, + "WorkspaceNotificationRecipientEmail" +); +@@clientName(WorkspaceNotification.workspaceNotificationRecipientEmailDelete, + "Delete" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(NotificationContract.properties +); + +@@clientLocation(OpenidConnectProviderContracts.get, "OpenIdConnectProvider"); +@@clientLocation(OpenidConnectProviderContracts.getEntityTag, + "OpenIdConnectProvider" +); +@@clientLocation(OpenidConnectProviderContracts.createOrUpdate, + "OpenIdConnectProvider" +); +@@clientName(OpenidConnectProviderContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(OpenidConnectProviderContracts.update, + "OpenIdConnectProvider" +); +@@clientName(OpenidConnectProviderContracts.update::parameters.properties, + "parameters" +); +@@clientLocation(OpenidConnectProviderContracts.delete, + "OpenIdConnectProvider" +); +@@clientLocation(OpenidConnectProviderContracts.listByService, + "OpenIdConnectProvider" +); +@@clientLocation(OpenidConnectProviderContracts.listSecrets, + "OpenIdConnectProvider" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(OpenidConnectProviderContract.properties +); + +@@clientLocation(PolicyFragmentContracts.get, "PolicyFragment"); +@@clientLocation(PolicyFragmentContracts.getEntityTag, "PolicyFragment"); +@@clientLocation(PolicyFragmentContracts.createOrUpdate, "PolicyFragment"); +@@clientName(PolicyFragmentContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(PolicyFragmentContracts.delete, "PolicyFragment"); +@@clientLocation(PolicyFragmentContracts.listByService, "PolicyFragment"); +@@clientLocation(PolicyFragmentContracts.listReferences, "PolicyFragment"); +@@clientName(WorkspacePolicyFragment.createOrUpdate::parameters.resource, + "parameters" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PolicyFragmentContract.properties +); + +@@clientLocation(PolicyRestrictionContracts.get, "PolicyRestriction"); +@@clientLocation(PolicyRestrictionContracts.getEntityTag, "PolicyRestriction"); +@@clientLocation(PolicyRestrictionContracts.createOrUpdate, + "PolicyRestriction" +); +@@clientName(PolicyRestrictionContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(PolicyRestrictionContracts.update, "PolicyRestriction"); +@@clientName(PolicyRestrictionContracts.update::parameters.properties, + "parameters" +); +@@clientLocation(PolicyRestrictionContracts.delete, "PolicyRestriction"); +@@clientLocation(PolicyRestrictionContracts.listByService, "PolicyRestriction"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PolicyRestrictionContract.properties +); + +@@clientLocation(PortalConfigContracts.get, "PortalConfig"); +@@clientLocation(PortalConfigContracts.getEntityTag, "PortalConfig"); +@@clientLocation(PortalConfigContracts.createOrUpdate, "PortalConfig"); +@@clientName(PortalConfigContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(PortalConfigContracts.update, "PortalConfig"); +@@clientName(PortalConfigContracts.update::parameters.properties, "parameters"); +@@clientLocation(PortalConfigContracts.listByService, "PortalConfig"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PortalConfigContract.properties +); + +@@clientLocation(ClientApplicationContracts.get, "ClientApplication"); +@@clientLocation(ClientApplicationContracts.getEntityTag, "ClientApplication"); +@@clientLocation(ClientApplicationContracts.createOrUpdate, + "ClientApplication" +); +@@clientName(ClientApplicationContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(ClientApplicationContracts.delete, "ClientApplication"); +@@clientLocation(ClientApplicationContracts.listByService, "ClientApplication"); +@@clientLocation(ClientApplicationContracts.listSecrets, "ClientApplication"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ClientApplicationContract.properties +); + +@@clientLocation(ClientApplicationProductLinkContracts.get, + "ClientApplicationProductLink" +); +@@clientLocation(ClientApplicationProductLinkContracts.create, + "ClientApplicationProductLink" +); +@@clientName(ClientApplicationProductLinkContracts.create::parameters.resource, + "parameters" +); +@@clientLocation(ClientApplicationProductLinkContracts.delete, + "ClientApplicationProductLink" +); +@@clientLocation(ClientApplicationProductLinkContracts.listByClientApplications, + "ClientApplicationProductLink" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ClientApplicationProductLinkContract.properties +); + +@@clientLocation(PortalRevisionContracts.get, "PortalRevision"); +@@clientLocation(PortalRevisionContracts.getEntityTag, "PortalRevision"); +@@clientLocation(PortalRevisionContracts.createOrUpdate, "PortalRevision"); +@@clientName(PortalRevisionContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(PortalRevisionContracts.update, "PortalRevision"); +@@clientName(PortalRevisionContracts.update::parameters.properties, + "parameters" +); +@@clientLocation(PortalRevisionContracts.listByService, "PortalRevision"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PortalRevisionContract.properties +); + +@@clientName(SignInSettings.createOrUpdate::parameters.resource, "parameters"); +@@clientName(SignInSettings.update::parameters.properties, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PortalSigninSettings.properties +); + +@@clientName(SignUpSettings.createOrUpdate::parameters.resource, "parameters"); +@@clientName(SignUpSettings.update::parameters.properties, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PortalSignupSettings.properties +); + +@@clientName(DelegationSettings.createOrUpdate::parameters.resource, + "parameters" +); +@@clientName(DelegationSettings.update::parameters.properties, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PortalDelegationSettings.properties +); + +@@clientLocation(PrivateEndpointConnections.getByName, + "PrivateEndpointConnection" +); +@@clientLocation(PrivateEndpointConnections.createOrUpdate, + "PrivateEndpointConnection" +); +@@clientName(PrivateEndpointConnections.createOrUpdate::parameters.resource, + "privateEndpointConnectionRequest" +); +@@clientLocation(PrivateEndpointConnections.delete, + "PrivateEndpointConnection" +); +@@clientLocation(PrivateEndpointConnections.listByService, + "PrivateEndpointConnection" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PrivateEndpointConnection.properties +); + +@@clientLocation(PrivateLinkResources.getPrivateLinkResource, + "PrivateEndpointConnection" +); +@@clientLocation(PrivateLinkResources.listPrivateLinkResources, + "PrivateEndpointConnection" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PrivateLinkResource.properties +); + +@@clientLocation(SubscriptionContracts.get, "Subscription"); +@@clientLocation(SubscriptionContracts.getEntityTag, "Subscription"); +@@clientLocation(SubscriptionContracts.createOrUpdate, "Subscription"); +@@clientName(SubscriptionContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(SubscriptionContracts.update, "Subscription"); +@@clientName(SubscriptionContracts.update::parameters.properties, "parameters"); +@@clientLocation(SubscriptionContracts.delete, "Subscription"); +@@clientLocation(SubscriptionContracts.list, "Subscription"); +@@clientLocation(SubscriptionContracts.regeneratePrimaryKey, "Subscription"); +@@clientLocation(SubscriptionContracts.regenerateSecondaryKey, "Subscription"); +@@clientLocation(SubscriptionContracts.listSecrets, "Subscription"); +@@clientName(WorkspaceSubscription.createOrUpdate::parameters.resource, + "parameters" +); +@@clientName(WorkspaceSubscription.update::parameters.properties, "parameters"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SubscriptionContract.properties +); + +@@clientLocation(ProductApiLinkContracts.get, "ProductApiLink"); +@@clientLocation(ProductApiLinkContracts.createOrUpdate, "ProductApiLink"); +@@clientName(ProductApiLinkContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(ProductApiLinkContracts.delete, "ProductApiLink"); +@@clientLocation(ProductApiLinkContracts.listByProduct, "ProductApiLink"); +@@clientName(WorkspaceProductApiLink.createOrUpdate::parameters.resource, + "parameters" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ProductApiLinkContract.properties +); + +@@clientLocation(ProductGroupLinkContracts.get, "ProductGroupLink"); +@@clientLocation(ProductGroupLinkContracts.createOrUpdate, "ProductGroupLink"); +@@clientName(ProductGroupLinkContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(ProductGroupLinkContracts.delete, "ProductGroupLink"); +@@clientLocation(ProductGroupLinkContracts.listByProduct, "ProductGroupLink"); +@@clientName(WorkspaceProductGroupLink.createOrUpdate::parameters.resource, + "parameters" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ProductGroupLinkContract.properties +); + +@@clientLocation(GlobalSchemaContracts.get, "GlobalSchema"); +@@clientLocation(GlobalSchemaContracts.getEntityTag, "GlobalSchema"); +@@clientLocation(GlobalSchemaContracts.createOrUpdate, "GlobalSchema"); +@@clientName(GlobalSchemaContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(GlobalSchemaContracts.delete, "GlobalSchema"); +@@clientLocation(GlobalSchemaContracts.listByService, "GlobalSchema"); +@@clientName(WorkspaceGlobalSchema.createOrUpdate::parameters.resource, + "parameters" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GlobalSchemaContract.properties +); + +@@clientLocation(TenantSettingsContracts.get, "TenantSettings"); +@@clientLocation(TenantSettingsContracts.listByService, "TenantSettings"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TenantSettingsContract.properties +); + +@@clientLocation(TagApiLinkContracts.get, "TagApiLink"); +@@clientLocation(TagApiLinkContracts.createOrUpdate, "TagApiLink"); +@@clientName(TagApiLinkContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(TagApiLinkContracts.delete, "TagApiLink"); +@@clientLocation(TagApiLinkContracts.listByProduct, "TagApiLink"); +@@clientName(WorkspaceTagApiLink.createOrUpdate::parameters.resource, + "parameters" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TagApiLinkContract.properties +); + +@@clientLocation(TagOperationLinkContracts.get, "TagOperationLink"); +@@clientLocation(TagOperationLinkContracts.createOrUpdate, "TagOperationLink"); +@@clientName(TagOperationLinkContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(TagOperationLinkContracts.delete, "TagOperationLink"); +@@clientLocation(TagOperationLinkContracts.listByProduct, "TagOperationLink"); +@@clientName(WorkspaceTagOperationLink.createOrUpdate::parameters.resource, + "parameters" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TagOperationLinkContract.properties +); + +@@clientLocation(TagProductLinkContracts.get, "TagProductLink"); +@@clientLocation(TagProductLinkContracts.createOrUpdate, "TagProductLink"); +@@clientName(TagProductLinkContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(TagProductLinkContracts.delete, "TagProductLink"); +@@clientLocation(TagProductLinkContracts.listByProduct, "TagProductLink"); +@@clientName(WorkspaceTagProductLink.createOrUpdate::parameters.resource, + "parameters" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TagProductLinkContract.properties +); + +@@clientLocation(AccessInformationContracts.get, "TenantAccess"); +@@clientLocation(AccessInformationContracts.getEntityTag, "TenantAccess"); +@@clientLocation(AccessInformationContracts.create, "TenantAccess"); +@@clientName(AccessInformationContracts.create::parameters.resource, + "parameters" +); +@@clientLocation(AccessInformationContracts.update, "TenantAccess"); +@@clientName(AccessInformationContracts.update::parameters.properties, + "parameters" +); +@@clientLocation(AccessInformationContracts.listByService, "TenantAccess"); +@@clientLocation(AccessInformationContracts.regeneratePrimaryKey, + "TenantAccess" +); +@@clientLocation(AccessInformationContracts.regenerateSecondaryKey, + "TenantAccess" +); +@@clientLocation(AccessInformationContracts.listSecrets, "TenantAccess"); +@@clientLocation(AccessInformationContracts.tenantAccessGitRegeneratePrimaryKey, + "TenantAccessGit" +); +@@clientName(AccessInformationContracts.tenantAccessGitRegeneratePrimaryKey, + "RegeneratePrimaryKey" +); +@@clientLocation(AccessInformationContracts.tenantAccessGitRegenerateSecondaryKey, + "TenantAccessGit" +); +@@clientName(AccessInformationContracts.tenantAccessGitRegenerateSecondaryKey, + "RegenerateSecondaryKey" +); +@@clientLocation(AccessInformationContracts.deploy, "TenantConfiguration"); +@@clientName(AccessInformationContracts.deploy::parameters.body, "parameters"); +@@clientLocation(AccessInformationContracts.save, "TenantConfiguration"); +@@clientName(AccessInformationContracts.save::parameters.body, "parameters"); +@@clientLocation(AccessInformationContracts.validate, "TenantConfiguration"); +@@clientName(AccessInformationContracts.validate::parameters.body, + "parameters" +); +@@clientLocation(AccessInformationContracts.getSyncState, + "TenantConfiguration" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AccessInformationContract.properties +); + +@@clientLocation(ApiManagementWorkspaceLinksResources.get, + "ApiManagementWorkspaceLink" +); +@@clientLocation(ApiManagementWorkspaceLinksResources.listByService, + "ApiManagementWorkspaceLinks" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiManagementWorkspaceLinksResource.properties +); + +@@clientLocation(WorkspaceContracts.get, "Workspace"); +@@clientLocation(WorkspaceContracts.getEntityTag, "Workspace"); +@@clientLocation(WorkspaceContracts.createOrUpdate, "Workspace"); +@@clientName(WorkspaceContracts.createOrUpdate::parameters.resource, + "parameters" +); +@@clientLocation(WorkspaceContracts.update, "Workspace"); +@@clientName(WorkspaceContracts.update::parameters.properties, "parameters"); +@@clientLocation(WorkspaceContracts.delete, "Workspace"); +@@clientLocation(WorkspaceContracts.listByService, "Workspace"); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(WorkspaceContract.properties +); + +@@clientLocation(ApiExportOperationGroup.get, "ApiExport"); + +@@clientLocation(DeletedServicesOperationGroup.listBySubscription, + "DeletedServices" +); + +@@clientLocation(ApiManagementServiceOperationGroup.checkNameAvailability, + "ApiManagementService" +); +@@clientLocation(ApiManagementServiceOperationGroup.getDomainOwnershipIdentifier, + "ApiManagementService" +); + +@@clientLocation(ApiManagementSkusOperationGroup.list, "ApiManagementSkus"); + +@@clientLocation(WorkspaceApiExportOperationGroup.get, "WorkspaceApiExport"); + +@@clientLocation(OperationStatusOperationGroup.get, "OperationStatus"); + +@@clientLocation(OperationsResultsOperationGroup.get, "OperationsResults"); + +@@clientName(ApiManagementServiceOperationGroup.checkNameAvailability::parameters.body, + "parameters" +); +@@doc(Azure.ResourceManager.ArmLroLocationHeader.location, "Location header"); +@@TypeSpec.Http.header(Azure.ResourceManager.ArmLroLocationHeader.location, + "location" +); +@@TypeSpec.Http.header(Azure.ResourceManager.ArmCombinedLroHeaders.location, + "location" +); +@@doc(Azure.ResourceManager.ArmCombinedLroHeaders.location, + "Location header contains the URL where the status of the long running operation can be checked" +); +@@doc(Azure.ResourceManager.ArmCombinedLroHeaders.azureAsyncOperation, + "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" +); +@@doc(Azure.ResourceManager.ArmCombinedLroHeaders.location, "Location header"); +@@clientName(BackendSessionIdSource, "Backend-sessionId-source"); +@@clientName(HttpHeader, "HTTPHeader"); +@@clientName(GlobalSchemaContractProperties.schemaType, "SchemaType"); +@@clientName(LlmDiagnosticSettings, "Llm-diagnostic-settings"); +@@clientName(LlmMessageLogTypes, "Llm-message-log-types"); +@@clientName(ApiManagementServiceResources.quotaByCounterKeysUpdate::parameters.body, + "parameters" +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementAllPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementAllPolicies.json new file mode 100644 index 000000000000..047f5780d071 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementAllPolicies.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "allpolicies1", + "type": "Microsoft.ApiManagement/service/allpolicies", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/allpolicies/allpolicies1", + "properties": { + "complianceState": "Compliant", + "referencePolicyId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/policies/policy" + } + } + ] + } + } + }, + "operationId": "AllPolicies_ListByService", + "title": "ApiManagementListPolicyRestrictions" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementApplyNetworkConfigurationUpdates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementApplyNetworkConfigurationUpdates.json new file mode 100644 index 000000000000..e69d708fad93 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementApplyNetworkConfigurationUpdates.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "location": "west us" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAXX6Y=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "East Asia", + "properties": { + "createdAtUtc": "2015-09-22T01:50:34.7921566Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "207.46.155.24" + ], + "publisherEmail": "admin@live.com", + "publisherName": "Contoso", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/eastUsVirtualNetwork/subnets/apimSubnet" + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "tags": { + "UID": "52ed5986-717b-45b4-b17c-3df8db372cff" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" + } + } + }, + "operationId": "ApiManagementService_ApplyNetworkConfigurationUpdates", + "title": "ApiManagementApplyNetworkConfigurationUpdates" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementApproveOrRejectPrivateEndpointConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementApproveOrRejectPrivateEndpointConnection.json new file mode 100644 index 000000000000..c064cb93ff3a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementApproveOrRejectPrivateEndpointConnection.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "privateEndpointConnectionRequest": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName", + "properties": { + "privateLinkServiceConnectionState": { + "description": "The Private Endpoint Connection is approved.", + "status": "Approved" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "privateEndpointConnectionName", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "description": "The request has been approved.", + "status": "Succeeded" + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "PrivateEndpointConnection_CreateOrUpdate", + "title": "ApiManagementApproveOrRejectPrivateEndpointConnection" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementAuthorizationServerListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementAuthorizationServerListSecrets.json new file mode 100644 index 000000000000..a31441b4f8ef --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementAuthorizationServerListSecrets.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authsid": "newauthServer2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "clientSecret": "2", + "resourceOwnerPassword": "pwd", + "resourceOwnerUsername": "un" + } + } + }, + "operationId": "AuthorizationServer_ListSecrets", + "title": "ApiManagementAuthorizationServerListSecrets" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementBackendReconnect.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementBackendReconnect.json new file mode 100644 index 000000000000..1275159866c3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementBackendReconnect.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "backendId": "proxybackend", + "parameters": { + "properties": { + "after": "PT3S" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": {} + }, + "operationId": "Backend_Reconnect", + "title": "ApiManagementBackendReconnect" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementBackupWithAccessKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementBackupWithAccessKey.json new file mode 100644 index 000000000000..56b5aae8f816 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementBackupWithAccessKey.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "accessKey": "**************************************************", + "accessType": "AccessKey", + "backupName": "apimService1backup_2017_03_19", + "containerName": "backupContainer", + "storageAccount": "teststorageaccount" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAACXok=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "West US", + "properties": { + "additionalLocations": [ + { + "disableGateway": true, + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "location": "East US", + "publicIPAddresses": [ + "23.101.138.153" + ], + "sku": { + "name": "Premium", + "capacity": 1 + } + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, + "createdAtUtc": "2019-12-18T06:26:20.3348609Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "defaultSslBinding": false, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + }, + { + "type": "Proxy", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" + }, + "defaultSslBinding": true, + "hostName": "gateway1.msitesting.net", + "negotiateClientCertificate": false + }, + { + "type": "Management", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" + }, + "defaultSslBinding": false, + "hostName": "mgmt.msitesting.net", + "negotiateClientCertificate": false + }, + { + "type": "Portal", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" + }, + "defaultSslBinding": false, + "hostName": "portal1.msitesting.net", + "negotiateClientCertificate": false + }, + { + "type": "ConfigurationApi", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" + }, + "defaultSslBinding": false, + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.91.32.113" + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" + } + } + }, + "operationId": "ApiManagementService_Backup", + "title": "ApiManagementBackupWithAccessKey" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementBackupWithSystemManagedIdentity.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementBackupWithSystemManagedIdentity.json new file mode 100644 index 000000000000..d6dcdbdb5540 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementBackupWithSystemManagedIdentity.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "accessType": "SystemAssignedManagedIdentity", + "backupName": "backup5", + "containerName": "apim-backups", + "storageAccount": "contosorpstorage" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAQM8o=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-5fb4-4916-95d4-64b306f9d924", + "tenantId": "00000000-86f1-0000-91ab-2d7cd011db47", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": { + "clientId": "00000000-a154-4830-0000-46a12da1a1e2", + "principalId": "00000000-a100-4478-0000-d65d98118ba0" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": { + "clientId": "00000000-6328-4db2-0000-ab0e3e7806cf", + "principalId": "00000000-9208-4128-af2d-a10d2af9b5a3" + } + } + }, + "location": "Central US EUAP", + "properties": { + "createdAtUtc": "2020-04-23T16:26:47.8637967Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-centraluseuap-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv1", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "52.XXXX.160.66" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "apimService1@corp.microsoft.com", + "publisherName": "MS", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "systemData": { + "lastModifiedAt": "2021-06-30T06:24:57.0008037Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User" + }, + "tags": { + "Owner": "apimService1" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" + } + } + }, + "operationId": "ApiManagementService_Backup", + "title": "ApiManagementBackupWithSystemManagedIdentity" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementBackupWithUserAssignedManagedIdentity.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementBackupWithUserAssignedManagedIdentity.json new file mode 100644 index 000000000000..615220f75fcf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementBackupWithUserAssignedManagedIdentity.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "accessType": "UserAssignedManagedIdentity", + "backupName": "backup5", + "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2", + "containerName": "apim-backups", + "storageAccount": "contosorpstorage" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAQM8o=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-5fb4-4916-95d4-64b306f9d924", + "tenantId": "00000000-86f1-0000-91ab-2d7cd011db47", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": { + "clientId": "00000000-a154-4830-0000-46a12da1a1e2", + "principalId": "00000000-a100-4478-0000-d65d98118ba0" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": { + "clientId": "00000000-6328-4db2-0000-ab0e3e7806cf", + "principalId": "00000000-9208-4128-af2d-a10d2af9b5a3" + } + } + }, + "location": "Central US EUAP", + "properties": { + "createdAtUtc": "2020-04-23T16:26:47.8637967Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-centraluseuap-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv1", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "52.XXXX.160.66" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "apimService1@corp.microsoft.com", + "publisherName": "MS", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "systemData": { + "lastModifiedAt": "2021-06-30T06:24:57.0008037Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User" + }, + "tags": { + "Owner": "apimService1" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" + } + } + }, + "operationId": "ApiManagementService_Backup", + "title": "ApiManagementBackupWithUserAssignedManagedIdentity" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAILogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAILogger.json new file mode 100644 index 000000000000..7759f9cf87c2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAILogger.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "loggerId": "loggerId", + "parameters": { + "properties": { + "description": "adding a new logger", + "credentials": { + "instrumentationKey": "11................a1" + }, + "loggerType": "applicationInsights" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "loggerId", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId", + "properties": { + "description": null, + "credentials": { + "instrumentationKey": "{{5a.......2a}}" + }, + "isBuffered": false, + "loggerType": "applicationInsights" + } + } + }, + "201": { + "body": { + "name": "loggerId", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId", + "properties": { + "description": null, + "credentials": { + "instrumentationKey": "{{5a.......2a}}" + }, + "isBuffered": false, + "loggerType": "applicationInsights", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.insights/components/airesource" + } + } + } + }, + "operationId": "Logger_CreateOrUpdate", + "title": "ApiManagementCreateAILogger" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApi.json new file mode 100644 index 000000000000..5f5c6976b256 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApi.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "tempgroup", + "parameters": { + "properties": { + "path": "newapiPath", + "description": "apidescription5200", + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + }, + "displayName": "apiname1463", + "protocols": [ + "https", + "http" + ], + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "path": "newapiPath", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + ] + }, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "path": "newapiPath", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + ] + }, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiClone.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiClone.json new file mode 100644 index 000000000000..7c9999e439c9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiClone.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "echo-api2", + "parameters": { + "properties": { + "path": "echo2", + "description": "Copy of Existing Echo Api including Operations.", + "displayName": "Echo API2", + "isCurrent": true, + "protocols": [ + "http", + "https" + ], + "serviceUrl": "http://echoapi.cloudapp.net/api", + "sourceApiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58a4aeac497000007d040001", + "subscriptionRequired": true + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "echoapi2", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapi2", + "properties": { + "path": "echo2", + "description": "Copy of Existing Echo Api including Operations.", + "apiRevision": "1", + "displayName": "Echo API2", + "isCurrent": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "subscriptionRequired": true + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + }, + "201": { + "body": { + "name": "echoapi2", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapi2", + "properties": { + "path": "echo2", + "description": "Copy of Existing Echo Api including Operations.", + "apiRevision": "1", + "displayName": "Echo API2", + "isCurrent": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "subscriptionRequired": true + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiClone" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiDiagnostic.json new file mode 100644 index 000000000000..660faddf8681 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiDiagnostic.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "diagnosticId": "applicationinsights", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + } + }, + "201": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + } + } + }, + "operationId": "ApiDiagnostic_CreateOrUpdate", + "title": "ApiManagementCreateApiDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiIssue.json new file mode 100644 index 000000000000..25ddfcec182d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiIssue.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "parameters": { + "properties": { + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "title": "New API issue", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", + "properties": { + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "title": "New API issue", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + }, + "201": { + "body": { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", + "properties": { + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "title": "New API issue", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + } + }, + "operationId": "ApiIssue_CreateOrUpdate", + "title": "ApiManagementCreateApiIssue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiIssueAttachment.json new file mode 100644 index 000000000000..a729cabb2eb0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiIssueAttachment.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "attachmentId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "parameters": { + "properties": { + "content": "IEJhc2U2NA==", + "contentFormat": "image/jpeg", + "title": "Issue attachment." + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", + "properties": { + "content": "https://.../image.jpg", + "contentFormat": "link", + "title": "Issue attachment." + } + } + }, + "201": { + "body": { + "name": "57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", + "properties": { + "content": "https://.../image.jpg", + "contentFormat": "link", + "title": "Issue attachment." + } + } + } + }, + "operationId": "ApiIssueAttachment_CreateOrUpdate", + "title": "ApiManagementCreateApiIssueAttachment" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiIssueComment.json new file mode 100644 index 000000000000..712fcd1e24ac --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiIssueComment.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "commentId": "599e29ab193c3c0bd0b3e2fb", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "parameters": { + "properties": { + "createdDate": "2018-02-01T22:21:20.467Z", + "text": "Issue comment.", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", + "properties": { + "createdDate": "2018-02-01T22:21:20.467Z", + "text": "Issue comment.", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + }, + "201": { + "body": { + "name": "599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", + "properties": { + "createdDate": "2018-02-01T22:21:20.467Z", + "text": "Issue comment.", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + } + }, + "operationId": "ApiIssueComment_CreateOrUpdate", + "title": "ApiManagementCreateApiIssueComment" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiNewVersionUsingExistingApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiNewVersionUsingExistingApi.json new file mode 100644 index 000000000000..3141c987e6a2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiNewVersionUsingExistingApi.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "echoapiv3", + "parameters": { + "properties": { + "path": "echo2", + "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.", + "apiVersion": "v4", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", + "displayName": "Echo API2", + "isCurrent": true, + "protocols": [ + "http", + "https" + ], + "serviceUrl": "http://echoapi.cloudapp.net/api", + "sourceApiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoPath", + "subscriptionRequired": true + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "echoapiv3", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapiv3", + "properties": { + "path": "echo2", + "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.", + "apiRevision": "1", + "apiVersion": "v4", + "apiVersionSet": { + "name": "Echo API2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", + "versioningScheme": "Segment" + }, + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", + "displayName": "Echo API2", + "isCurrent": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "subscriptionRequired": true + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "echoapiv3", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapiv3", + "properties": { + "path": "echo2", + "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.", + "apiRevision": "1", + "apiVersion": "v4", + "apiVersionSet": { + "name": "Echo API2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", + "versioningScheme": "Segment" + }, + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", + "displayName": "Echo API2", + "isCurrent": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "subscriptionRequired": true + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiNewVersionUsingExistingApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiOperation.json new file mode 100644 index 000000000000..a3c20272f740 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiOperation.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "operationId": "newoperations", + "api-version": "2024-10-01-preview", + "apiId": "PetStoreTemplate2", + "parameters": { + "properties": { + "method": "POST", + "description": "This can only be done by the logged in user.", + "displayName": "createUser2", + "templateParameters": [], + "urlTemplate": "/user1", + "request": { + "description": "Created user object", + "headers": [], + "queryParameters": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "description": "successful operation", + "headers": [], + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "statusCode": 200 + } + ] + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "newoperations", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations", + "properties": { + "method": "POST", + "description": "This can only be done by the logged in user.", + "displayName": "createUser2", + "templateParameters": [], + "urlTemplate": "/user1", + "request": { + "description": "Created user object", + "headers": [], + "queryParameters": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "description": "successful operation", + "headers": [], + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "statusCode": 200 + } + ] + } + } + }, + "201": { + "body": { + "name": "newoperations", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations", + "properties": { + "method": "POST", + "description": "This can only be done by the logged in user.", + "displayName": "createUser2", + "templateParameters": [], + "urlTemplate": "/user1", + "request": { + "description": "Created user object", + "headers": [], + "queryParameters": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "description": "successful operation", + "headers": [], + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "statusCode": 200 + } + ] + } + } + } + }, + "operationId": "ApiOperation_CreateOrUpdate", + "title": "ApiManagementCreateApiOperation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiOperationPolicy.json new file mode 100644 index 000000000000..411ea93db239 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiOperationPolicy.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "operationId": "5600b57e7e8880006a080001", + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "5600b57e7e8880006a040001", + "parameters": { + "properties": { + "format": "xml", + "value": " " + } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "201": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "ApiOperationPolicy_CreateOrUpdate", + "title": "ApiManagementCreateApiOperationPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiOperationTag.json new file mode 100644 index 000000000000..d0ca5a8bedc5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiOperationTag.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "operationId": "5931a75ae4bbd512a88c680a", + "api-version": "2024-10-01-preview", + "apiId": "5931a75ae4bbd512a88c680b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tagId1" + }, + "responses": { + "200": { + "body": { + "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "201": { + "body": { + "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "properties": { + "displayName": "tag1" + } + } + } + }, + "operationId": "Tag_AssignToOperation", + "title": "ApiManagementCreateApiOperationTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiPolicy.json new file mode 100644 index 000000000000..2d2059f7ef02 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiPolicy.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "5600b57e7e8880006a040001", + "parameters": { + "properties": { + "format": "xml", + "value": " " + } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "201": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "ApiPolicy_CreateOrUpdate", + "title": "ApiManagementCreateApiPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiPolicyNonXmlEncoded.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiPolicyNonXmlEncoded.json new file mode 100644 index 000000000000..90c6c5a7e479 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiPolicyNonXmlEncoded.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "5600b57e7e8880006a040001", + "parameters": { + "properties": { + "format": "rawxml", + "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n " + } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "id": "/subscriptions/4c1a3bc6-89f9-46fe-a175-5d8984b25095/resourcegroups/Api-DF-West-US/providers/Microsoft.ApiManagement/service/samirmsiservice2/apis/echo-api/operations/create-resource/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n" + } + } + }, + "201": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "id": "/subscriptions/4c1a3bc6-89f9-46fe-a175-5d8984b25095/resourcegroups/Api-DF-West-US/providers/Microsoft.ApiManagement/service/samirmsiservice2/apis/echo-api/operations/create-resource/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n" + } + } + } + }, + "operationId": "ApiPolicy_CreateOrUpdate", + "title": "ApiManagementCreateApiPolicyNonXmlEncoded" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiRelease.json new file mode 100644 index 000000000000..905668b1f7f5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiRelease.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "a1", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "notes": "yahooagain" + } + }, + "releaseId": "testrev", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "testrev", + "type": "Microsoft.ApiManagement/service/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "createdDateTime": "2018-02-08T20:52:00.65Z", + "notes": "yahooagain", + "updatedDateTime": "2018-02-08T20:52:00.65Z" + } + } + }, + "201": { + "body": { + "name": "testrev", + "type": "Microsoft.ApiManagement/service/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "createdDateTime": "2018-02-08T20:52:00.65Z", + "notes": "yahooagain", + "updatedDateTime": "2018-02-08T20:52:00.65Z" + } + } + } + }, + "operationId": "ApiRelease_CreateOrUpdate", + "title": "ApiManagementCreateApiRelease" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiRevisionFromExistingApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiRevisionFromExistingApi.json new file mode 100644 index 000000000000..7e5ac16660af --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiRevisionFromExistingApi.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "echo-api;rev=3", + "parameters": { + "properties": { + "path": "echo", + "apiRevisionDescription": "Creating a Revision of an existing API", + "serviceUrl": "http://echoapi.cloudapp.net/apiv3", + "sourceApiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", + "properties": { + "path": "echo", + "apiRevision": "3", + "apiRevisionDescription": "Creating a Revision of an existing API", + "displayName": "Echo API", + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://echoapi.cloudapp.net/apiv3", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "subscriptionRequired": true + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", + "properties": { + "path": "echo", + "apiRevision": "3", + "apiRevisionDescription": "Creating a Revision of an existing API", + "displayName": "Echo API", + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://echoapi.cloudapp.net/apiv3", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "subscriptionRequired": true + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiRevisionFromExistingApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiSchema.json new file mode 100644 index 000000000000..48e51d42203e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiSchema.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "parameters": { + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "resourceGroupName": "rg1", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + }, + "provisioningState": "InProgress" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + }, + "provisioningState": "InProgress" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "ApiSchema_CreateOrUpdate", + "title": "ApiManagementCreateApiSchema" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiTag.json new file mode 100644 index 000000000000..186073f735bc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiTag.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "5931a75ae4bbd512a88c680b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tagId1" + }, + "responses": { + "200": { + "body": { + "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "201": { + "body": { + "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "properties": { + "displayName": "tag1" + } + } + } + }, + "operationId": "Tag_AssignToApi", + "title": "ApiManagementCreateApiTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiTagDescription.json new file mode 100644 index 000000000000..008aba626c37 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiTagDescription.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "5931a75ae4bbd512a88c680b", + "parameters": { + "properties": { + "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API", + "externalDocsDescription": "Description of the external docs resource", + "externalDocsUrl": "http://some.url/additionaldoc" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagDescriptionId": "tagId1" + }, + "responses": { + "200": { + "body": { + "name": "tagId1", + "type": "Microsoft.ApiManagement/service/apis/tagDescriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1", + "properties": { + "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API", + "displayName": "tag1", + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com", + "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1" + } + } + }, + "201": { + "body": { + "name": "tagId1", + "type": "Microsoft.ApiManagement/service/apis/tagDescriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1", + "properties": { + "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API", + "displayName": "tag1", + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com", + "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1" + } + } + } + }, + "operationId": "ApiTagDescription_CreateOrUpdate", + "title": "ApiManagementCreateApiTagDescription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingImportOverrideServiceUrl.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingImportOverrideServiceUrl.json new file mode 100644 index 000000000000..0db0b6969063 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingImportOverrideServiceUrl.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "apidocs", + "parameters": { + "properties": { + "format": "swagger-link", + "path": "petstoreapi123", + "serviceUrl": "http://petstore.swagger.wordnik.com/api", + "value": "http://apimpimportviaurl.azurewebsites.net/api/apidocs/" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apidocs", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs", + "properties": { + "path": "petstoreapi123", + "description": "This is a sample server Petstore server. You can find out more about Swagger \n at http://swagger.wordnik.com or on irc.freenode.net, #swagger. For this sample,\n you can use the api key \"special-key\" to test the authorization filters", + "apiRevision": "1", + "displayName": "Swagger Sample App", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.wordnik.com/api", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "apidocs", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs", + "properties": { + "path": "petstoreapi123", + "description": "This is a sample server Petstore server. You can find out more about Swagger \n at http://swagger.wordnik.com or on irc.freenode.net, #swagger. For this sample,\n you can use the api key \"special-key\" to test the authorization filters", + "apiRevision": "1", + "displayName": "Swagger Sample App", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.wordnik.com/api", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiUsingImportOverrideServiceUrl" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingOai3Import.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingOai3Import.json new file mode 100644 index 000000000000..0e0cfcad9282 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingOai3Import.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "petstore", + "parameters": { + "properties": { + "format": "openapi-link", + "path": "petstore", + "value": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", + "properties": { + "path": "petstore", + "apiRevision": "1", + "displayName": "Swagger Petstore", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v1", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", + "properties": { + "path": "petstore", + "apiRevision": "1", + "displayName": "Swagger Petstore", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v1", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiUsingOai3Import" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct.json new file mode 100644 index 000000000000..8a07ac666675 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "petstore", + "parameters": { + "properties": { + "format": "openapi-link", + "path": "petstore", + "translateRequiredQueryParameters": "template", + "value": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", + "properties": { + "path": "petstore", + "apiRevision": "1", + "displayName": "Swagger Petstore", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v1", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + }, + "201": { + "body": { + "name": "petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", + "properties": { + "path": "petstore", + "apiRevision": "1", + "displayName": "Swagger Petstore", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v1", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingSwaggerImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingSwaggerImport.json new file mode 100644 index 000000000000..e9e40a1f1f02 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingSwaggerImport.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "petstore", + "parameters": { + "properties": { + "format": "swagger-link-json", + "path": "petstore", + "value": "http://petstore.swagger.io/v2/swagger.json" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", + "properties": { + "path": "petstore", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "apiRevision": "1", + "displayName": "Swagger Petstore", + "isCurrent": true, + "protocols": [ + "http" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v2", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", + "properties": { + "path": "petstore", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "apiRevision": "1", + "displayName": "Swagger Petstore", + "isCurrent": true, + "protocols": [ + "http" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v2", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiUsingSwaggerImport" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingWadlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingWadlImport.json new file mode 100644 index 000000000000..5f492ab28e2a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiUsingWadlImport.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "petstore", + "parameters": { + "properties": { + "format": "wadl-link-json", + "path": "collector", + "value": "https://developer.cisco.com/media/wae-release-6-2-api-reference/wae-collector-rest-api/application.wadl" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "collectorwadl", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/collectorwadl", + "properties": { + "path": "collector", + "description": "", + "apiRevision": "1", + "displayName": "http://localhost:8080/collector-northbound", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://localhost:8080/collector-northbound", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "collectorwadl", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/collectorwadl", + "properties": { + "path": "collector", + "description": "", + "apiRevision": "1", + "displayName": "http://localhost:8080/collector-northbound", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://localhost:8080/collector-northbound", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiUsingWadlImport" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiVersionSet.json new file mode 100644 index 000000000000..01f94a1323cf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiVersionSet.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "description": "Version configuration", + "displayName": "api set 1", + "versioningScheme": "Segment" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "api1" + }, + "responses": { + "200": { + "body": { + "name": "api1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1", + "properties": { + "description": "Version configuration", + "displayName": "api set 1", + "versioningScheme": "Segment" + } + } + }, + "201": { + "body": { + "name": "api1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1", + "properties": { + "description": "Version configuration", + "displayName": "api set 1", + "versioningScheme": "Segment" + } + } + } + }, + "operationId": "ApiVersionSet_CreateOrUpdate", + "title": "ApiManagementCreateApiVersionSet" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiWiki.json new file mode 100644 index 000000000000..d4973df63be0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiWiki.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + } + }, + "operationId": "ApiWiki_CreateOrUpdate", + "title": "ApiManagementCreateApiWiki" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiWithMultipleAuthServers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiWithMultipleAuthServers.json new file mode 100644 index 000000000000..b849bb46a60e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiWithMultipleAuthServers.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "tempgroup", + "parameters": { + "properties": { + "path": "newapiPath", + "description": "apidescription5200", + "authenticationSettings": { + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + { + "authorizationServerId": "authorizationServerId2284", + "scope": "oauth2scope2581" + } + ] + }, + "displayName": "apiname1463", + "protocols": [ + "https", + "http" + ], + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "path": "newapiPath", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + { + "authorizationServerId": "authorizationServerId2284", + "scope": "oauth2scope2581" + } + ] + }, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "path": "newapiPath", + "description": "apidescription5200", + "apiRevision": "1", + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiWithMultipleAuthServers" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json new file mode 100644 index 000000000000..39f505a12a80 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "tempgroup", + "parameters": { + "properties": { + "path": "newapiPath", + "description": "apidescription5200", + "authenticationSettings": { + "openidAuthenticationSettings": [ + { + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "openidProviderId": "openidProviderId2283" + }, + { + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "openidProviderId": "openidProviderId2284" + } + ] + }, + "displayName": "apiname1463", + "protocols": [ + "https", + "http" + ], + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "path": "newapiPath", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": { + "openid": { + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "openidProviderId": "openidProviderId2283" + }, + "openidAuthenticationSettings": [ + { + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "openidProviderId": "openidProviderId2283" + }, + { + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "openidProviderId": "openidProviderId2284" + } + ] + }, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "path": "newapiPath", + "description": "apidescription5200", + "apiRevision": "1", + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiWithMultipleOpenIdConnectProviders" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiWithOpenIdConnect.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiWithOpenIdConnect.json new file mode 100644 index 000000000000..a379092f0fd8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateApiWithOpenIdConnect.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "tempgroup", + "parameters": { + "properties": { + "path": "petstore", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "authenticationSettings": { + "openid": { + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "openidProviderId": "testopenid" + } + }, + "displayName": "Swagger Petstore", + "protocols": [ + "https" + ], + "serviceUrl": "http://petstore.swagger.io/v2", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "58da4c4ccdae970a08121230", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58da4c4ccdae970a08121230", + "properties": { + "path": "petstore", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "apiRevision": "1", + "authenticationSettings": { + "openid": { + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "openidProviderId": "testopenid" + } + }, + "displayName": "Swagger Petstore", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v2", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "58da4c4ccdae970a08121230", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58da4c4ccdae970a08121230", + "properties": { + "path": "petstore", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "apiRevision": "1", + "authenticationSettings": { + "openid": { + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "openidProviderId": "testopenid" + } + }, + "displayName": "Swagger Petstore", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v2", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiWithOpenIdConnect" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationAADAuthCode.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationAADAuthCode.json new file mode 100644 index 000000000000..fc7f2865a341 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationAADAuthCode.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationId": "authz2", + "authorizationProviderId": "aadwithauthcode", + "parameters": { + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "AuthorizationCode" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "authz2", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz2", + "properties": { + "authorizationType": "OAuth2", + "error": { + "code": "Unauthenticated", + "message": "This connection is not authenticated." + }, + "oauth2grantType": "AuthorizationCode", + "status": "Error" + } + } + }, + "201": { + "body": { + "name": "authz2", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz2", + "properties": { + "authorizationType": "OAuth2", + "error": { + "code": "Unauthenticated", + "message": "This connection is not authenticated." + }, + "oauth2grantType": "AuthorizationCode", + "status": "Error" + } + } + } + }, + "operationId": "Authorization_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationAADAuthCode" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationAADClientCred.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationAADClientCred.json new file mode 100644 index 000000000000..9f2aea4fb757 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationAADClientCred.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationId": "authz1", + "authorizationProviderId": "aadwithclientcred", + "parameters": { + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "AuthorizationCode", + "parameters": { + "clientId": "clientsecretid", + "clientSecret": "clientsecretvalue" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz1", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "ClientCredentials", + "parameters": { + "clientId": "clientsecretid" + }, + "status": "Connected" + } + } + }, + "201": { + "body": { + "name": "authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz1", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "ClientCredentials", + "parameters": { + "clientId": "clientsecretid" + }, + "status": "Connected" + } + } + } + }, + "operationId": "Authorization_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationAADClientCred" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationAccessPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationAccessPolicy.json new file mode 100644 index 000000000000..b60a4eefa2c0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationAccessPolicy.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationAccessPolicyId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "authorizationId": "authz1", + "authorizationProviderId": "aadwithauthcode", + "parameters": { + "properties": { + "appIds": [ + "d5f04bb0-ba78-4878-a43e-35a0b74fe315" + ], + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies/fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "properties": { + "appIds": [ + "d5f04bb0-ba78-4878-a43e-35a0b74fe315" + ], + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff" + } + } + }, + "201": { + "body": { + "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies/fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "properties": { + "appIds": [ + "d5f04bb0-ba78-4878-a43e-35a0b74fe315" + ], + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff" + } + } + } + }, + "operationId": "AuthorizationAccessPolicy_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationAccessPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationProviderAADAuthCode.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationProviderAADAuthCode.json new file mode 100644 index 000000000000..9bb65e3e17b5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationProviderAADAuthCode.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationProviderId": "aadwithauthcode", + "parameters": { + "properties": { + "displayName": "aadwithauthcode", + "identityProvider": "aad", + "oauth2": { + "grantTypes": { + "authorizationCode": { + "clientId": "clientsecretid", + "clientSecret": "clientsecretvalue", + "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "aadwithauthcode", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", + "properties": { + "displayName": "aadwithauthcode", + "identityProvider": "aad", + "oauth2": { + "grantTypes": { + "authorizationCode": { + "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d", + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All", + "tenantId": "common" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + } + }, + "201": { + "body": { + "name": "aadwithauthcode", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", + "properties": { + "displayName": "aadwithauthcode", + "identityProvider": "aad", + "oauth2": { + "grantTypes": { + "authorizationCode": { + "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d", + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All", + "tenantId": "common" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + } + } + }, + "operationId": "AuthorizationProvider_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationProviderAADAuthCode" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationProviderAADClientCred.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationProviderAADClientCred.json new file mode 100644 index 000000000000..d59a6f0db60a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationProviderAADClientCred.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationProviderId": "aadwithclientcred", + "parameters": { + "properties": { + "displayName": "aadwithclientcred", + "identityProvider": "aad", + "oauth2": { + "grantTypes": { + "authorizationCode": { + "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "aadwithclientcred", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred", + "properties": { + "displayName": "aadwithclientcred", + "identityProvider": "aad", + "oauth2": { + "grantTypes": { + "clientCredentials": { + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All", + "tenantId": "common" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + } + }, + "201": { + "body": { + "name": "aadwithclientcred", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred", + "properties": { + "displayName": "aadwithclientcred", + "identityProvider": "aad", + "oauth2": { + "grantTypes": { + "clientCredentials": { + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All", + "tenantId": "common" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + } + } + }, + "operationId": "AuthorizationProvider_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationProviderAADClientCred" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationProviderGenericOAuth2.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationProviderGenericOAuth2.json new file mode 100644 index 000000000000..8d3ab7246718 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationProviderGenericOAuth2.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationProviderId": "eventbrite", + "parameters": { + "properties": { + "displayName": "eventbrite", + "identityProvider": "oauth2", + "oauth2": { + "grantTypes": { + "authorizationCode": { + "authorizationUrl": "https://www.eventbrite.com/oauth/authorize", + "clientId": "clientid", + "clientSecret": "clientsecretvalue", + "refreshUrl": "https://www.eventbrite.com/oauth/token", + "scopes": null, + "tokenUrl": "https://www.eventbrite.com/oauth/token" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "eventbrite", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/eventbrite", + "properties": { + "displayName": "eventbrite", + "identityProvider": "oauth2", + "oauth2": { + "grantTypes": { + "authorizationCode": { + "authorizationUrl": "https://www.eventbrite.com/oauth/authorize", + "clientId": "clientid", + "refreshUrl": "https://www.eventbrite.com/oauth/token", + "scopes": null, + "tokenUrl": "https://www.eventbrite.com/oauth/token" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + } + }, + "201": { + "body": { + "name": "eventbrite", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/eventbrite", + "properties": { + "displayName": "eventbrite", + "identityProvider": "oauth2", + "oauth2": { + "grantTypes": { + "authorizationCode": { + "authorizationUrl": "https://www.eventbrite.com/oauth/authorize", + "clientId": "clientid", + "refreshUrl": "https://www.eventbrite.com/oauth/token", + "scopes": null, + "tokenUrl": "https://www.eventbrite.com/oauth/token" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + } + } + }, + "operationId": "AuthorizationProvider_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationProviderGenericOAuth2" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationProviderOOBGoogle.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationProviderOOBGoogle.json new file mode 100644 index 000000000000..5c356b8a7638 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationProviderOOBGoogle.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationProviderId": "google", + "parameters": { + "properties": { + "displayName": "google", + "identityProvider": "google", + "oauth2": { + "grantTypes": { + "authorizationCode": { + "clientId": "99999999-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com", + "clientSecret": "clientsecretvalue", + "scopes": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "google", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/google", + "properties": { + "displayName": "google", + "identityProvider": "google", + "oauth2": { + "grantTypes": { + "authorizationCode": { + "clientId": "99999999-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com", + "scopes": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + } + }, + "201": { + "body": { + "name": "google", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/google", + "properties": { + "displayName": "google", + "identityProvider": "google", + "oauth2": { + "grantTypes": { + "authorizationCode": { + "clientId": "99999999-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com", + "scopes": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + } + } + }, + "operationId": "AuthorizationProvider_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationProviderOOBGoogle" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationServer.json new file mode 100644 index 000000000000..261eb7501522 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateAuthorizationServer.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authsid": "newauthServer", + "parameters": { + "properties": { + "description": "test server", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "clientSecret": "2", + "defaultScope": "read write", + "displayName": "test2", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "resourceOwnerPassword": "pwd", + "resourceOwnerUsername": "un", + "supportState": true, + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "useInApiDocumentation": true, + "useInTestConsole": false + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", + "properties": { + "description": "test server", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "defaultScope": "read write", + "displayName": "test2", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "resourceOwnerPassword": "pwd", + "resourceOwnerUsername": "un", + "supportState": true, + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "useInApiDocumentation": true, + "useInTestConsole": false + } + } + }, + "201": { + "body": { + "name": "newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", + "properties": { + "description": "test server", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "defaultScope": "read write", + "displayName": "test2", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "resourceOwnerPassword": "pwd", + "resourceOwnerUsername": "un", + "supportState": true, + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "useInApiDocumentation": true, + "useInTestConsole": false + } + } + } + }, + "operationId": "AuthorizationServer_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationServer" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendProxyBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendProxyBackend.json new file mode 100644 index 000000000000..363a476aba36 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendProxyBackend.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "backendId": "proxybackend", + "parameters": { + "properties": { + "description": "description5308", + "credentials": { + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + } + }, + "proxy": { + "password": "", + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin" + }, + "tls": { + "validateCertificateChain": true, + "validateCertificateName": true + }, + "url": "https://backendname2644/", + "protocol": "http" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", + "properties": { + "description": "description5308", + "credentials": { + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + } + }, + "proxy": { + "password": "", + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + }, + "url": "https://backendname2644/", + "protocol": "http" + } + } + }, + "201": { + "body": { + "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", + "properties": { + "description": "description5308", + "credentials": { + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + } + }, + "proxy": { + "password": "", + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + }, + "url": "https://backendname2644/", + "protocol": "http" + } + } + } + }, + "operationId": "Backend_CreateOrUpdate", + "title": "ApiManagementCreateBackendProxyBackend" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendServiceFabric.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendServiceFabric.json new file mode 100644 index 000000000000..06d5cd6af593 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendServiceFabric.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "backendId": "sfbackend", + "parameters": { + "properties": { + "description": "Service Fabric Test App 1", + "properties": { + "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "managementEndpoints": [ + "https://somecluster.com" + ], + "maxPartitionResolutionRetries": 5, + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ] + } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "properties": { + "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "managementEndpoints": [ + "https://somecluster.com" + ], + "maxPartitionResolutionRetries": 5, + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ] + } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" + } + } + }, + "201": { + "body": { + "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "properties": { + "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "managementEndpoints": [ + "https://somecluster.com" + ], + "maxPartitionResolutionRetries": 5, + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ] + } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" + } + } + } + }, + "operationId": "Backend_CreateOrUpdate", + "title": "ApiManagementCreateBackendServiceFabric" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendWithPriorityBasedLoadBalancer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendWithPriorityBasedLoadBalancer.json new file mode 100644 index 000000000000..9906d01d082d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendWithPriorityBasedLoadBalancer.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "backendId": "priority-based-load-balancer", + "parameters": { + "properties": { + "type": "Pool", + "pool": { + "services": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1", + "priority": 1 + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2", + "priority": 1 + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-3", + "priority": 2 + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-4", + "priority": 2 + } + ] + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "priority-based-load-balancer", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/priority-based-load-balancer", + "properties": { + "type": "Pool", + "pool": { + "services": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1", + "priority": 1 + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2", + "priority": 1 + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-3", + "priority": 2 + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-4", + "priority": 2 + } + ] + }, + "title": null, + "url": null, + "protocol": null + } + } + }, + "201": { + "body": { + "name": "priority-based-load-balancer", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/priority-based-load-balancer", + "properties": { + "type": "Pool", + "pool": { + "services": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1", + "priority": 1 + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2", + "priority": 1 + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-3", + "priority": 2 + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-4", + "priority": 2 + } + ] + }, + "title": null, + "url": null, + "protocol": null + } + } + } + }, + "operationId": "Backend_CreateOrUpdate", + "title": "ApiManagementCreateBackendWithPriorityBasedLoadBalancer" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendWithSimpleLoadBalancer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendWithSimpleLoadBalancer.json new file mode 100644 index 000000000000..0d4cd2cc68d4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendWithSimpleLoadBalancer.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "backendId": "simple-load-balancer", + "parameters": { + "properties": { + "type": "Pool", + "pool": { + "services": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2" + } + ] + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "simple-load-balancer", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/simple-load-balancer", + "properties": { + "type": "Pool", + "pool": { + "services": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2" + } + ] + }, + "title": null, + "url": null, + "protocol": null + } + } + }, + "201": { + "body": { + "name": "simple-load-balancer", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/simple-load-balancer", + "properties": { + "type": "Pool", + "pool": { + "services": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2" + } + ] + }, + "title": null, + "url": null, + "protocol": null + } + } + } + }, + "operationId": "Backend_CreateOrUpdate", + "title": "ApiManagementCreateBackendWithSimpleLoadBalancer" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendWithWeightedLoadBalancer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendWithWeightedLoadBalancer.json new file mode 100644 index 000000000000..5fa26138de8e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateBackendWithWeightedLoadBalancer.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "backendId": "weighted-load-balancer", + "parameters": { + "properties": { + "type": "Pool", + "pool": { + "services": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1", + "weight": 75 + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2", + "weight": 25 + } + ] + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "weighted-load-balancer", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/weighted-load-balancer", + "properties": { + "type": "Pool", + "pool": { + "services": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1", + "weight": 75 + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2", + "weight": 25 + } + ] + }, + "title": null, + "url": null, + "protocol": null + } + } + }, + "201": { + "body": { + "name": "weighted-load-balancer", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/weighted-load-balancer", + "properties": { + "type": "Pool", + "pool": { + "services": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1", + "weight": 75 + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2", + "weight": 25 + } + ] + }, + "title": null, + "url": null, + "protocol": null + } + } + } + }, + "operationId": "Backend_CreateOrUpdate", + "title": "ApiManagementCreateBackendWithWeightedLoadBalancer" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateCache.json new file mode 100644 index 000000000000..20c52068f62f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateCache.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "cacheId": "c1", + "parameters": { + "properties": { + "description": "Redis cache instances in West India", + "connectionString": "apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False", + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1", + "useFromLocation": "default" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "c1", + "type": "Microsoft.ApiManagement/service/caches", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", + "properties": { + "description": "Redis cache instances in West India", + "connectionString": "{{5f7fbca77a891a2200f3db38}}", + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1", + "useFromLocation": "default" + } + } + }, + "201": { + "body": { + "name": "c1", + "type": "Microsoft.ApiManagement/service/caches", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", + "properties": { + "description": "Redis cache instances in West India", + "connectionString": "{{5f7fbca77a891a2200f3db38}}", + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1", + "useFromLocation": "default" + } + } + } + }, + "operationId": "Cache_CreateOrUpdate", + "title": "ApiManagementCreateCache" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateCertificate.json new file mode 100644 index 000000000000..182886e07755 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateCertificate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "tempcert", + "parameters": { + "properties": { + "data": "****************Base 64 Encoded Certificate *******************************", + "password": "****Certificate Password******" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "tempcert", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert", + "properties": { + "expirationDate": "2018-03-17T21:55:07+00:00", + "subject": "CN=contoso.com", + "thumbprint": "*******************3" + } + } + }, + "201": { + "body": { + "name": "tempcert", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert", + "properties": { + "expirationDate": "2018-03-17T21:55:07+00:00", + "subject": "CN=contoso.com", + "thumbprint": "*******************3" + } + } + } + }, + "operationId": "Certificate_CreateOrUpdate", + "title": "ApiManagementCreateCertificate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateCertificateWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateCertificateWithKeyVault.json new file mode 100644 index 000000000000..110afb7687ad --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateCertificateWithKeyVault.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "templateCertkv", + "parameters": { + "properties": { + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", + "properties": { + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" + } + } + }, + "201": { + "body": { + "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", + "properties": { + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" + } + } + } + }, + "operationId": "Certificate_CreateOrUpdate", + "title": "ApiManagementCreateCertificateWithKeyVault" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateClientApplication.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateClientApplication.json new file mode 100644 index 000000000000..bbc6983230f9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateClientApplication.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "clientApplicationId": "testAppId", + "parameters": { + "properties": { + "description": "This is just an example application", + "displayName": "Test Application", + "ownerId": "/users/userId" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "testAppId", + "type": "Microsoft.ApiManagement/service/clientApplications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId", + "properties": { + "description": "This is just an example application", + "displayName": "Test Application", + "entraApplicationId": "00000000-0000-0000-0000-000000000000", + "entraTenantId": "00000000-0000-0000-0000-000000000010", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId", + "state": "active" + } + } + }, + "201": { + "body": { + "name": "testAppId", + "type": "Microsoft.ApiManagement/service/clientApplications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId", + "properties": { + "description": "This is just an example application", + "displayName": "Test Application", + "entraApplicationId": "00000000-0000-0000-0000-000000000001", + "entraTenantId": "00000000-0000-0000-0000-000000000011", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId", + "state": "active" + } + } + } + }, + "operationId": "ClientApplication_CreateOrUpdate", + "title": "ApiManagementCreateProduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateClientApplicationProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateClientApplicationProductLink.json new file mode 100644 index 000000000000..68af8000a02d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateClientApplicationProductLink.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "clientApplicationId": "testAppId", + "clientApplicationProductLinkId": "link1", + "parameters": { + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter" + } + } + }, + "201": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter" + } + } + } + }, + "operationId": "ClientApplicationProductLink_Create", + "title": "ApiManagementCreateClientApplicationProductLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateContentType.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateContentType.json new file mode 100644 index 000000000000..83747d30a7e3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateContentType.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "contentTypeId": "page", + "parameters": { + "properties": { + "name": "Page", + "schema": { + "additionalProperties": false, + "properties": { + "en_us": { + "type": "object", + "additionalProperties": false, + "properties": { + "description": { + "type": "string", + "description": "Page description. This property gets included in SEO attributes.", + "indexed": true, + "title": "Description" + }, + "documentId": { + "type": "string", + "description": "Reference to page content document.", + "title": "Document ID" + }, + "keywords": { + "type": "string", + "description": "Page keywords. This property gets included in SEO attributes.", + "indexed": true, + "title": "Keywords" + }, + "permalink": { + "type": "string", + "description": "Page permalink, e.g. '/about'.", + "indexed": true, + "title": "Permalink" + }, + "title": { + "type": "string", + "description": "Page title. This property gets included in SEO attributes.", + "indexed": true, + "title": "Title" + } + }, + "required": [ + "title", + "permalink", + "documentId" + ] + } + } + }, + "description": "A regular page", + "version": "1.0.0" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "page", + "type": "Microsoft.ApiManagement/service/contentTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/contentTypes/page", + "properties": { + "name": "Page", + "schema": { + "additionalProperties": false, + "properties": { + "en_us": { + "type": "object", + "additionalProperties": false, + "properties": { + "description": { + "type": "string", + "description": "Page description. This property gets included in SEO attributes.", + "indexed": true, + "title": "Description" + }, + "documentId": { + "type": "string", + "description": "Reference to page content document.", + "title": "Document ID" + }, + "keywords": { + "type": "string", + "description": "Page keywords. This property gets included in SEO attributes.", + "indexed": true, + "title": "Keywords" + }, + "permalink": { + "type": "string", + "description": "Page permalink, e.g. '/about'.", + "indexed": true, + "title": "Permalink" + }, + "title": { + "type": "string", + "description": "Page title. This property gets included in SEO attributes.", + "indexed": true, + "title": "Title" + } + }, + "required": [ + "title", + "permalink", + "documentId" + ] + } + } + }, + "description": "A regular page", + "version": "1.0.0" + } + } + }, + "201": { + "body": { + "name": "page", + "type": "Microsoft.ApiManagement/service/contentTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/contentTypes/page", + "properties": { + "name": "Page", + "schema": { + "additionalProperties": false, + "properties": { + "en_us": { + "type": "object", + "additionalProperties": false, + "properties": { + "description": { + "type": "string", + "description": "Page description. This property gets included in SEO attributes.", + "indexed": true, + "title": "Description" + }, + "documentId": { + "type": "string", + "description": "Reference to page content document.", + "title": "Document ID" + }, + "keywords": { + "type": "string", + "description": "Page keywords. This property gets included in SEO attributes.", + "indexed": true, + "title": "Keywords" + }, + "permalink": { + "type": "string", + "description": "Page permalink, e.g. '/about'.", + "indexed": true, + "title": "Permalink" + }, + "title": { + "type": "string", + "description": "Page title. This property gets included in SEO attributes.", + "indexed": true, + "title": "Title" + } + }, + "required": [ + "title", + "permalink", + "documentId" + ] + } + } + }, + "description": "A regular page", + "version": "1.0.0" + } + } + } + }, + "operationId": "ContentType_CreateOrUpdate", + "title": "ApiManagementCreateContentType" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateContentTypeContentItem.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateContentTypeContentItem.json new file mode 100644 index 000000000000..ab167eaaac33 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateContentTypeContentItem.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "contentTypeId": "page", + "parameters": { + "properties": { + "en_us": { + "description": "Short story about the company.", + "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "keywords": "company, about", + "permalink": "/about", + "title": "About" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "properties": { + "en_us": { + "description": "Short story about the company.", + "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "keywords": "company, about", + "permalink": "/about", + "title": "About" + } + } + } + }, + "201": { + "body": { + "name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "properties": { + "en_us": { + "description": "Short story about the company.", + "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "keywords": "company, about", + "permalink": "/about", + "title": "About" + } + } + } + } + }, + "operationId": "ContentItem_CreateOrUpdate", + "title": "ApiManagementCreateContentTypeContentItem" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateDiagnostic.json new file mode 100644 index 000000000000..c73e4fb9685a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateDiagnostic.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "diagnosticId": "applicationinsights", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/loggers/azuremonitor", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + } + }, + "201": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/loggers/azuremonitor", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + } + } + }, + "operationId": "Diagnostic_CreateOrUpdate", + "title": "ApiManagementCreateDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateDocumentation.json new file mode 100644 index 000000000000..e68d4755955e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateDocumentation.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "documentationId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "content": "content", + "title": "Title" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/documentations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", + "properties": { + "content": "content", + "title": "Title" + } + } + }, + "201": { + "body": { + "name": "57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/documentations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", + "properties": { + "content": "content", + "title": "Title" + } + } + } + }, + "operationId": "Documentation_CreateOrUpdate", + "title": "ApiManagementCreateDocumentation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateEHLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateEHLogger.json new file mode 100644 index 000000000000..3db11b1921bb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateEHLogger.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "loggerId": "eh1", + "parameters": { + "properties": { + "description": "adding a new logger", + "credentials": { + "name": "hydraeventhub", + "connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********=" + }, + "loggerType": "azureEventHub" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "eh1", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1", + "properties": { + "description": "adding a new logger", + "credentials": { + "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" + }, + "isBuffered": true, + "loggerType": "azureEventHub" + } + } + }, + "201": { + "body": { + "name": "eh1", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1", + "properties": { + "description": "adding a new logger", + "credentials": { + "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" + }, + "isBuffered": true, + "loggerType": "azureEventHub" + } + } + } + }, + "operationId": "Logger_CreateOrUpdate", + "title": "ApiManagementCreateEHLogger" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGateway.json new file mode 100644 index 000000000000..85f0f35263c6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGateway.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "parameters": { + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "a1", + "type": "Microsoft.ApiManagement/service/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location" + } + } + } + }, + "201": { + "body": { + "name": "a1", + "type": "Microsoft.ApiManagement/service/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location" + } + } + } + } + }, + "operationId": "Gateway_CreateOrUpdate", + "title": "ApiManagementCreateGateway" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGatewayApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGatewayApi.json new file mode 100644 index 000000000000..2ccc10648bdb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGatewayApi.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "gatewayId": "gw1", + "parameters": { + "properties": { + "provisioningState": "created" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "echo-api", + "type": "Microsoft.ApiManagement/service/gateways/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/echo-api", + "properties": { + "path": "", + "apiRevision": "1", + "displayName": "EchoApi", + "isCurrent": true, + "protocols": [ + "http", + "https" + ], + "serviceUrl": "https://contoso.com/apis/echo", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + } + }, + "201": { + "body": { + "name": "echo-api", + "type": "Microsoft.ApiManagement/service/gateways/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/echo-api", + "properties": { + "path": "", + "apiRevision": "1", + "displayName": "EchoApi", + "isCurrent": true, + "protocols": [ + "http", + "https" + ], + "serviceUrl": "https://contoso.com/apis/echo", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + } + } + }, + "operationId": "GatewayApi_CreateOrUpdate", + "title": "ApiManagementCreateGatewayApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGatewayCertificateAuthority.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGatewayCertificateAuthority.json new file mode 100644 index 000000000000..45d5511a1013 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGatewayCertificateAuthority.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "cert1", + "gatewayId": "gw1", + "parameters": { + "properties": { + "isTrusted": false + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "cert1", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", + "properties": { + "isTrusted": false + } + } + }, + "201": { + "body": { + "name": "cert1", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", + "properties": { + "isTrusted": false + } + } + } + }, + "operationId": "GatewayCertificateAuthority_CreateOrUpdate", + "title": "ApiManagementCreateGatewayCertificateAuthority" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGatewayConfigConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGatewayConfigConnection.json new file mode 100644 index 000000000000..f06bae9aafda --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGatewayConfigConnection.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "configConnectionName": "gcc-01", + "gatewayName": "standard-gw-01", + "parameters": { + "properties": { + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001" + } + }, + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "gcc-1", + "type": "Microsoft.ApiManagement/gateways/configConnections", + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", + "properties": { + "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net", + "provisioningState": "Succeeded", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001" + } + } + }, + "201": { + "body": { + "name": "gcc-1", + "type": "Microsoft.ApiManagement/gateways/configConnections", + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", + "properties": { + "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net", + "provisioningState": "Succeeded", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001" + } + } + } + }, + "operationId": "ApiGatewayConfigConnection_CreateOrUpdate", + "title": "ApiManagementCreateGatewayConfigConnection" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGatewayHostnameConfiguration.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGatewayHostnameConfiguration.json new file mode 100644 index 000000000000..2ab90d18e5ed --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGatewayHostnameConfiguration.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "hcId": "default", + "parameters": { + "properties": { + "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "hostname": "*", + "http2Enabled": true, + "negotiateClientCertificate": false, + "tls10Enabled": false, + "tls11Enabled": false + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", + "properties": { + "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "hostname": "*", + "http2Enabled": true, + "negotiateClientCertificate": false, + "tls10Enabled": false, + "tls11Enabled": false + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", + "properties": { + "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "hostname": "*", + "http2Enabled": true, + "negotiateClientCertificate": false, + "tls10Enabled": false, + "tls11Enabled": false + } + } + } + }, + "operationId": "GatewayHostnameConfiguration_CreateOrUpdate", + "title": "ApiManagementCreateGatewayHostnameConfiguration" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGlobalSchema1.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGlobalSchema1.json new file mode 100644 index 000000000000..e467ed895ff1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGlobalSchema1.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + }, + "resourceGroupName": "rg1", + "schemaId": "schema1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", + "properties": { + "description": "sample schema description", + "provisioningState": "InProgress", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", + "properties": { + "description": "sample schema description", + "provisioningState": "InProgress", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "GlobalSchema_CreateOrUpdate", + "title": "ApiManagementCreateSchema1" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGlobalSchema2.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGlobalSchema2.json new file mode 100644 index 000000000000..d358f45190c2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGlobalSchema2.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "description": "sample schema description", + "document": { + "type": "object", + "$id": "https://example.com/person.schema.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "properties": { + "age": { + "type": "integer", + "description": "Age in years which must be equal to or greater than zero.", + "minimum": 0 + }, + "firstName": { + "type": "string", + "description": "The person's first name." + }, + "lastName": { + "type": "string", + "description": "The person's last name." + } + }, + "title": "Person" + }, + "schemaType": "json" + } + }, + "resourceGroupName": "rg1", + "schemaId": "schema1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", + "properties": { + "description": "sample schema description", + "document": { + "type": "object", + "$id": "https://example.com/person.schema.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "properties": { + "age": { + "type": "integer", + "description": "Age in years which must be equal to or greater than zero.", + "minimum": 0 + }, + "firstName": { + "type": "string", + "description": "The person's first name." + }, + "lastName": { + "type": "string", + "description": "The person's last name." + } + }, + "title": "Person" + }, + "provisioningState": "InProgress", + "schemaType": "json" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", + "properties": { + "description": "sample schema description", + "document": { + "type": "object", + "$id": "https://example.com/person.schema.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "properties": { + "age": { + "type": "integer", + "description": "Age in years which must be equal to or greater than zero.", + "minimum": 0 + }, + "firstName": { + "type": "string", + "description": "The person's first name." + }, + "lastName": { + "type": "string", + "description": "The person's last name." + } + }, + "title": "Person" + }, + "provisioningState": "InProgress", + "schemaType": "json" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "GlobalSchema_CreateOrUpdate", + "title": "ApiManagementCreateSchema2" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGraphQLApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGraphQLApi.json new file mode 100644 index 000000000000..d309f7a90aba --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGraphQLApi.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "tempgroup", + "parameters": { + "properties": { + "type": "graphql", + "path": "graphql-api", + "description": "apidescription5200", + "displayName": "apiname1463", + "protocols": [ + "http", + "https" + ], + "serviceUrl": "https://api.spacex.land/graphql" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "type": "graphql", + "path": "graphql-api", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": null, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "https://api.spacex.land/graphql", + "subscriptionKeyParameterNames": null + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "type": "graphql", + "path": "graphql-api", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": null, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "https", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "https://api.spacex.land/graphql", + "subscriptionKeyParameterNames": null + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateGraphQLApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGraphQLApiResolver.json new file mode 100644 index 000000000000..1edae1671fa2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGraphQLApiResolver.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "someAPI", + "parameters": { + "properties": { + "path": "Query/users", + "description": "A GraphQL Resolver example", + "displayName": "Query Users" + } + }, + "resolverId": "newResolver", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "newResolver", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/someAPI/resolvers/newResolver", + "properties": { + "path": "Query/users", + "description": "A GraphQL Resolver example", + "displayName": "Query Users" + } + } + }, + "201": { + "body": { + "name": "newResolver", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/someAPI/resolvers/newResolver", + "properties": { + "path": "Query/users", + "description": "A GraphQL Resolver example", + "displayName": "Query Users" + } + } + } + }, + "operationId": "GraphQLApiResolver_CreateOrUpdate", + "title": "ApiManagementCreateGraphQLApiResolver" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGraphQLApiResolverPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGraphQLApiResolverPolicy.json new file mode 100644 index 000000000000..f812f0df22d2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGraphQLApiResolverPolicy.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "5600b57e7e8880006a040001", + "parameters": { + "properties": { + "format": "xml", + "value": "GET/api/users" + } + }, + "policyId": "policy", + "resolverId": "5600b57e7e8880006a080001", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/resolvers/5600b57e7e8880006a080001/policies/policy", + "properties": { + "value": "\r\n \r\n GET\r\n\r\n/api/users\r\n\r\n" + } + } + }, + "201": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/resolvers/5600b57e7e8880006a080001/policies/policy", + "properties": { + "value": "\r\n \r\n GET\r\n\r\n/api/users\r\n\r\n" + } + } + } + }, + "operationId": "GraphQLApiResolverPolicy_CreateOrUpdate", + "title": "ApiManagementCreateGraphQLApiResolverPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGroup.json new file mode 100644 index 000000000000..1701d6bc99bd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "tempgroup", + "parameters": { + "properties": { + "displayName": "temp group" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "tempgroup", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup", + "properties": { + "type": "custom", + "displayName": "temp group" + } + } + }, + "201": { + "body": { + "name": "tempgroup", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup", + "properties": { + "type": "custom", + "displayName": "temp group" + } + } + } + }, + "operationId": "Group_CreateOrUpdate", + "title": "ApiManagementCreateGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGroupExternal.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGroupExternal.json new file mode 100644 index 000000000000..16249c40a217 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGroupExternal.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "aadGroup", + "parameters": { + "properties": { + "type": "external", + "description": "new group to test", + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "aadGroup", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup", + "properties": { + "type": "external", + "description": "new group to test", + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + } + }, + "201": { + "body": { + "name": "aadGroup", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup", + "properties": { + "type": "external", + "description": "new group to test", + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + } + } + }, + "operationId": "Group_CreateOrUpdate", + "title": "ApiManagementCreateGroupExternal" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGroupUser.json new file mode 100644 index 000000000000..0320dba6980f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGroupUser.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "tempgroup", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "59307d350af58404d8a26300" + }, + "responses": { + "200": { + "body": { + "name": "59307d350af58404d8a26300", + "type": "Microsoft.ApiManagement/service/groups/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/59307d350af58404d8a26300", + "properties": { + "email": "testuser1@live.com", + "firstName": "test", + "groups": [], + "identities": [], + "lastName": "user", + "registrationDate": "2017-06-01T20:46:45.437Z", + "state": "active" + } + } + }, + "201": { + "body": { + "name": "59307d350af58404d8a26300", + "type": "Microsoft.ApiManagement/service/groups/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/59307d350af58404d8a26300", + "properties": { + "email": "testuser1@live.com", + "firstName": "test", + "groups": [], + "identities": [], + "lastName": "user", + "registrationDate": "2017-06-01T20:46:45.437Z", + "state": "active" + } + } + } + }, + "operationId": "GroupUser_Create", + "title": "ApiManagementCreateGroupUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGrpcApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGrpcApi.json new file mode 100644 index 000000000000..ac2f66847d21 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateGrpcApi.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "tempgroup", + "parameters": { + "properties": { + "type": "grpc", + "format": "grpc-link", + "path": "grpc-api", + "description": "apidescription5200", + "displayName": "apiname1463", + "protocols": [ + "https" + ], + "serviceUrl": "https://your-api-hostname/samples", + "value": "https://raw.githubusercontent.com/kedacore/keda/main/pkg/scalers/externalscaler/externalscaler.proto" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "type": "grpc", + "path": "grpc-api", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": null, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "https" + ], + "serviceUrl": "https://your-api-hostname/samples", + "subscriptionKeyParameterNames": null + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "type": "grpc", + "path": "grpc-api", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": null, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "https" + ], + "serviceUrl": "https://your-api-hostname/samples", + "subscriptionKeyParameterNames": null + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateGrpcApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateIdentityProvider.json new file mode 100644 index 000000000000..0dc9aac7b421 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateIdentityProvider.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "identityProviderName": "facebook", + "parameters": { + "properties": { + "clientId": "facebookid", + "clientSecret": "facebookapplicationsecret" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "Facebook", + "type": "Microsoft.ApiManagement/service/identityProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook", + "properties": { + "type": "facebook", + "clientId": "facebookid" + } + } + }, + "201": { + "body": { + "name": "Facebook", + "type": "Microsoft.ApiManagement/service/identityProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook", + "properties": { + "type": "facebook", + "clientId": "facebookid" + } + } + } + }, + "operationId": "IdentityProvider_CreateOrUpdate", + "title": "ApiManagementCreateIdentityProvider" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateMultiRegionServiceWithCustomHostname.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateMultiRegionServiceWithCustomHostname.json new file mode 100644 index 000000000000..3e7f276ee512 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateMultiRegionServiceWithCustomHostname.json @@ -0,0 +1,282 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "location": "West US", + "properties": { + "additionalLocations": [ + { + "disableGateway": true, + "location": "East US", + "sku": { + "name": "Premium", + "capacity": 1 + } + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificatePassword": "Password", + "defaultSslBinding": true, + "encodedCertificate": "****** Base 64 Encoded Certificate ************", + "hostName": "gateway1.msitesting.net" + }, + { + "type": "Management", + "certificatePassword": "Password", + "encodedCertificate": "****** Base 64 Encoded Certificate ************", + "hostName": "mgmt.msitesting.net" + }, + { + "type": "Portal", + "certificatePassword": "Password", + "encodedCertificate": "****** Base 64 Encoded Certificate ************", + "hostName": "portal1.msitesting.net" + }, + { + "type": "ConfigurationApi", + "certificatePassword": "Password", + "encodedCertificate": "****** Base 64 Encoded Certificate ************", + "hostName": "configuration-api.msitesting.net" + } + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAACXok=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "West US", + "properties": { + "additionalLocations": [ + { + "disableGateway": true, + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "location": "East US", + "publicIPAddresses": [ + "23.101.138.153" + ], + "sku": { + "name": "Premium", + "capacity": 1 + } + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, + "createdAtUtc": "2019-12-18T06:26:20.3348609Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "defaultSslBinding": false, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + }, + { + "type": "Proxy", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" + }, + "defaultSslBinding": true, + "hostName": "gateway1.msitesting.net", + "negotiateClientCertificate": false + }, + { + "type": "Management", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" + }, + "defaultSslBinding": false, + "hostName": "mgmt.msitesting.net", + "negotiateClientCertificate": false + }, + { + "type": "Portal", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" + }, + "defaultSslBinding": false, + "hostName": "portal1.msitesting.net", + "negotiateClientCertificate": false + }, + { + "type": "ConfigurationApi", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" + }, + "defaultSslBinding": false, + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.91.32.113" + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAACXoo=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "West US", + "properties": { + "additionalLocations": [ + { + "disableGateway": true, + "location": "East US", + "sku": { + "name": "Premium", + "capacity": 1 + } + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, + "createdAtUtc": "2019-12-18T08:04:26.9492661Z", + "disableGateway": false, + "hostnameConfigurations": [ + { + "type": "Proxy", + "defaultSslBinding": false, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + }, + { + "type": "Proxy", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" + }, + "defaultSslBinding": true, + "hostName": "gateway1.msitesting.net", + "negotiateClientCertificate": false + }, + { + "type": "Management", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" + }, + "defaultSslBinding": false, + "hostName": "mgmt.msitesting.net", + "negotiateClientCertificate": false + }, + { + "type": "Portal", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" + }, + "defaultSslBinding": false, + "hostName": "portal1.msitesting.net", + "negotiateClientCertificate": false + }, + { + "type": "ConfigurationApi", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" + }, + "defaultSslBinding": false, + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateMultiRegionServiceWithCustomHostname" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNamedValue.json new file mode 100644 index 000000000000..a0133bece8a8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNamedValue.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "namedValueId": "testprop2", + "parameters": { + "properties": { + "displayName": "prop3name", + "secret": false, + "tags": [ + "foo", + "bar" + ], + "value": "propValue" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "testprop2", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", + "properties": { + "displayName": "prop3name", + "provisioningState": "InProgress", + "secret": false, + "tags": [ + "foo", + "bar" + ], + "value": "propValue" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "testprop2", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", + "properties": { + "displayName": "prop3name", + "provisioningState": "InProgress", + "secret": false, + "tags": [ + "foo", + "bar" + ], + "value": "propValue" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "NamedValue_CreateOrUpdate", + "title": "ApiManagementCreateNamedValue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNamedValueWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNamedValueWithKeyVault.json new file mode 100644 index 000000000000..c8a7e5b7fc7c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNamedValueWithKeyVault.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "namedValueId": "testprop6", + "parameters": { + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" + }, + "secret": true, + "tags": [ + "foo", + "bar" + ] + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + }, + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" + }, + "provisioningState": "InProgress", + "secret": true, + "tags": [ + "foo", + "bar" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + }, + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" + }, + "provisioningState": "InProgress", + "secret": true, + "tags": [ + "foo", + "bar" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "NamedValue_CreateOrUpdate", + "title": "ApiManagementCreateNamedValueWithKeyVault" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNotification.json new file mode 100644 index 000000000000..a5c86fc95a87 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNotification.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", + "properties": { + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/contoso@live.com", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar!live", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + }, + "title": "Subscription requests (requiring approval)" + } + } + } + }, + "operationId": "Notification_CreateOrUpdate", + "title": "ApiManagementCreateNotification" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNotificationRecipientEmail.json new file mode 100644 index 000000000000..b012405fdecc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNotificationRecipientEmail.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "email": "foobar@live.com", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "foobar@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + }, + "201": { + "body": { + "name": "foobar@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + } + }, + "operationId": "NotificationRecipientEmail_CreateOrUpdate", + "title": "ApiManagementCreateNotificationRecipientEmail" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNotificationRecipientUser.json new file mode 100644 index 000000000000..cbdf96bcb453 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateNotificationRecipientUser.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "576823d0a40f7e74ec07d642" + }, + "responses": { + "200": { + "body": { + "name": "576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + }, + "201": { + "body": { + "name": "576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + } + }, + "operationId": "NotificationRecipientUser_CreateOrUpdate", + "title": "ApiManagementCreateNotificationRecipientUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateODataApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateODataApi.json new file mode 100644 index 000000000000..6059aaec3fd9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateODataApi.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "tempgroup", + "parameters": { + "properties": { + "type": "odata", + "format": "odata-link", + "path": "odata-api", + "description": "apidescription5200", + "displayName": "apiname1463", + "protocols": [ + "http", + "https" + ], + "serviceUrl": "https://services.odata.org/TripPinWebApiService", + "value": "https://services.odata.org/TripPinWebApiService/$metadata" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "type": "odata", + "path": "odata-api", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": null, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "https://services.odata.org/TripPinWebApiService", + "subscriptionKeyParameterNames": null + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "type": "odata", + "path": "odata-api", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": null, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "https://services.odata.org/TripPinWebApiService", + "subscriptionKeyParameterNames": null + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateODataApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateOpenIdConnectProvider.json new file mode 100644 index 000000000000..6095c1c5ba2f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateOpenIdConnectProvider.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "opid": "templateOpenIdConnect3", + "parameters": { + "properties": { + "clientId": "oidprovidertemplate3", + "clientSecret": "x", + "displayName": "templateoidprovider3", + "metadataEndpoint": "https://oidprovider-template3.net", + "useInApiDocumentation": true, + "useInTestConsole": false + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "templateOpenIdConnect3", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3", + "properties": { + "clientId": "oidprovidertemplate3", + "displayName": "templateoidprovider3", + "metadataEndpoint": "https://oidprovider-template3.net", + "useInApiDocumentation": true, + "useInTestConsole": false + } + } + }, + "201": { + "body": { + "name": "templateOpenIdConnect3", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3", + "properties": { + "clientId": "oidprovidertemplate3", + "displayName": "templateoidprovider3", + "metadataEndpoint": "https://oidprovider-template3.net", + "useInApiDocumentation": true, + "useInTestConsole": false + } + } + } + }, + "operationId": "OpenIdConnectProvider_CreateOrUpdate", + "title": "ApiManagementCreateOpenIdConnectProvider" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePolicy.json new file mode 100644 index 000000000000..52c41f18f83d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePolicy.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "format": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "201": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "Policy_CreateOrUpdate", + "title": "ApiManagementCreatePolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePolicyFragment.json new file mode 100644 index 000000000000..5da20b07d4d3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePolicyFragment.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "parameters": { + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "provisioningState": "InProgress", + "value": "" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "provisioningState": "InProgress", + "value": "" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "PolicyFragment_CreateOrUpdate", + "title": "ApiManagementCreatePolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePolicyRestriction.json new file mode 100644 index 000000000000..a0ec472466f5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePolicyRestriction.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "requireBase": "true", + "scope": "Sample Path to the policy document." + } + }, + "policyRestrictionId": "policyRestriction1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policyRestrictions1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", + "properties": { + "requireBase": "true", + "scope": "Sample Path to the policy document." + } + } + }, + "201": { + "body": { + "name": "policyRestrictions2", + "type": "Microsoft.ApiManagement/service/policyFragments", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", + "properties": { + "requireBase": "true", + "scope": "Sample Path to the policy document." + } + } + } + }, + "operationId": "PolicyRestriction_CreateOrUpdate", + "title": "ApiManagementCreatePolicyRestriction" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePortalConfig.json new file mode 100644 index 000000000000..6324c8aeabfd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePortalConfig.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] + }, + "csp": { + "allowedSources": [ + "*.contoso.com" + ], + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ] + }, + "delegation": { + "delegateRegistration": false, + "delegateSubscription": false, + "delegationUrl": null, + "validationKey": null + }, + "enableBasicAuth": true, + "signin": { + "require": false + }, + "signup": { + "termsOfService": { + "requireConsent": false, + "text": "I agree to the service terms and conditions." + } + } + } + }, + "portalConfigId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.ApiManagement/service/portalconfigs", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", + "properties": { + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] + }, + "csp": { + "allowedSources": [ + "*.contoso.com" + ], + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ] + }, + "delegation": { + "delegateRegistration": false, + "delegateSubscription": false, + "delegationUrl": null, + "validationKey": null + }, + "enableBasicAuth": true, + "signin": { + "require": false + }, + "signup": { + "termsOfService": { + "requireConsent": false, + "text": "I agree to the service terms and conditions." + } + } + } + } + } + }, + "operationId": "PortalConfig_CreateOrUpdate", + "title": "ApiManagementCreatePortalConfig" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePortalRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePortalRevision.json new file mode 100644 index 000000000000..e6c5d075fd21 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreatePortalRevision.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "description": "portal revision 1", + "isCurrent": true + } + }, + "portalRevisionId": "20201112101010", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "201": { + "body": { + "name": "20201112101010", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010", + "properties": { + "description": "portal revision 1", + "createdDateTime": "2020-11-13T22:28:43.657Z", + "isCurrent": true, + "provisioningState": "InProgress", + "status": "completed", + "statusDetails": null, + "updatedDateTime": "2020-11-13T22:29:22.68Z" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5faf089b1d9a026694220e0c?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2024-10-01-preview&asyncId=5faf089b1d9a026694220e0c&asyncCode=201" + } + } + }, + "operationId": "PortalRevision_CreateOrUpdate", + "title": "ApiManagementCreatePortalRevision" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProduct.json new file mode 100644 index 000000000000..b25ab5767d01 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProduct.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "displayName": "Test Template ProductName 4" + } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "testproduct", + "type": "Microsoft.ApiManagement/service/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct", + "properties": { + "approvalRequired": false, + "displayName": "Test Template ProductName 4", + "state": "notPublished", + "subscriptionRequired": true + } + } + }, + "201": { + "body": { + "name": "testproduct", + "type": "Microsoft.ApiManagement/service/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct", + "properties": { + "approvalRequired": false, + "displayName": "Test Template ProductName 4", + "state": "notPublished", + "subscriptionRequired": true + } + } + } + }, + "operationId": "Product_CreateOrUpdate", + "title": "ApiManagementCreateProduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductApi.json new file mode 100644 index 000000000000..7322d52247fc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductApi.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b", + "properties": { + "path": "", + "apiRevision": "1", + "displayName": "EchoApi", + "isCurrent": true, + "protocols": [ + "http", + "https" + ], + "serviceUrl": "https://contoso.com/apis/echo", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + } + }, + "201": { + "body": { + "name": "5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b", + "properties": { + "path": "", + "apiRevision": "1", + "displayName": "EchoApi", + "isCurrent": true, + "protocols": [ + "http", + "https" + ], + "serviceUrl": "https://contoso.com/apis/echo", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + } + } + }, + "operationId": "ProductApi_CreateOrUpdate", + "title": "ApiManagementCreateProductApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductApiLink.json new file mode 100644 index 000000000000..6ef64421c144 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductApiLink.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + }, + "201": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + } + }, + "operationId": "ProductApiLink_CreateOrUpdate", + "title": "ApiManagementCreateProductApiLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductGroup.json new file mode 100644 index 000000000000..ccb5c215babb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "templateGroup", + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "templateGroup", + "type": "Microsoft.ApiManagement/service/products/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup", + "properties": { + "type": "custom", + "description": "group created via Template", + "builtIn": false, + "displayName": "Template Group" + } + } + }, + "201": { + "body": { + "name": "templateGroup", + "type": "Microsoft.ApiManagement/service/products/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup", + "properties": { + "type": "custom", + "description": "group created via Template", + "builtIn": false, + "displayName": "Template Group" + } + } + } + }, + "operationId": "ProductGroup_CreateOrUpdate", + "title": "ApiManagementCreateProductGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductGroupLink.json new file mode 100644 index 000000000000..ee0d6c72444c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductGroupLink.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupLinkId": "link1", + "parameters": { + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" + } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/products/groupLinkId", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groupLinkId/link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" + } + } + }, + "201": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/products/groupLinkId", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groupLinkId/link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" + } + } + } + }, + "operationId": "ProductGroupLink_CreateOrUpdate", + "title": "ApiManagementCreateProductGroupLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductPolicy.json new file mode 100644 index 000000000000..4a379aa3f079 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductPolicy.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "format": "xml", + "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + }, + "policyId": "policy", + "productId": "5702e97e5157a50f48dce801", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5702e97e5157a50f48dce801/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "201": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5702e97e5157a50f48dce801/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "ProductPolicy_CreateOrUpdate", + "title": "ApiManagementCreateProductPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductTag.json new file mode 100644 index 000000000000..02e11f418ff4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductTag.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "5931a75ae4bbd512a88c680b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tagId1" + }, + "responses": { + "200": { + "body": { + "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "201": { + "body": { + "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "properties": { + "displayName": "tag1" + } + } + } + }, + "operationId": "Tag_AssignToProduct", + "title": "ApiManagementCreateProductTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductWiki.json new file mode 100644 index 000000000000..a9d698454981 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateProductWiki.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + }, + "productId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + } + }, + "operationId": "ProductWiki_CreateOrUpdate", + "title": "ApiManagementCreateProductWiki" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateService.json new file mode 100644 index 000000000000..91da915c925c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateService.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "location": "South Central US", + "properties": { + "publisherEmail": "foo@contoso.com", + "publisherName": "foo" + }, + "sku": { + "name": "Developer", + "capacity": 1 + }, + "tags": { + "Name": "Contoso", + "Test": "User" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAmREI=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "East US", + "properties": { + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv1", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.90.229.33" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "samir@microsoft.com", + "publisherName": "foo", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" + } + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAmRAM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "East US", + "properties": { + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "disableGateway": false, + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "undetermined", + "provisioningState": "Created", + "publicNetworkAccess": "Enabled", + "publisherEmail": "samir@microsoft.com", + "publisherName": "foo", + "releaseChannel": "Default", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateService" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceHavingMsi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceHavingMsi.json new file mode 100644 index 000000000000..f10ac9b40171 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceHavingMsi.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "West US", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAAWiU=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "SystemAssigned", + "principalId": "dfb9a757-df69-4966-a8d0-711a9cd8ffb4", + "tenantId": "00000000-86f1-41af-91ab-2d7cd011db47" + }, + "location": "West US", + "properties": { + "createdAtUtc": "2019-04-11T16:29:29.9711098Z", + "enableClientCertificate": false, + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "mtv1", + "provisioningState": "Succeeded", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + }, + "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAAWiE=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "SystemAssigned", + "principalId": "dfb9a757-df69-4966-a8d0-711a9cd8ffb4", + "tenantId": "00000000-86f1-41af-91ab-2d7cd011db47" + }, + "location": "West US", + "properties": { + "createdAtUtc": "2019-04-11T16:29:29.9711098Z", + "hostnameConfigurations": [ + { + "type": "Proxy", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + }, + "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceHavingMsi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceInVnetWithPublicIP.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceInVnetWithPublicIP.json new file mode 100644 index 000000000000..bbccc8055f62 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceInVnetWithPublicIP.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "location": "East US 2 EUAP", + "properties": { + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant" + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "Premium", + "capacity": 2 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "zones": [ + "1", + "2" + ] + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAGTAs=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.ApiManagement/service/apimService1", + "location": "East US 2 EUAP", + "properties": { + "createdAtUtc": "2021-02-22T06:53:46.6409875Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-eastus2euap-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "20.47.137.XXX" + ], + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant" + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "Premium", + "capacity": 2 + }, + "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "zones": [ + "1", + "2" + ] + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAiXto=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "East US 2 EUAP", + "properties": { + "createdAtUtc": "2020-07-28T23:18:14.6562474Z", + "disableGateway": false, + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2.1", + "provisioningState": "Created", + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant" + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "Premium", + "capacity": 2 + }, + "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "zones": [ + "1", + "2" + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceInVnetWithPublicIP" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceInZones.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceInZones.json new file mode 100644 index 000000000000..aea85144f27d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceInZones.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "location": "North europe", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk" + }, + "sku": { + "name": "Premium", + "capacity": 2 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "zones": [ + "1", + "2" + ] + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAiXvE=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "North Europe", + "properties": { + "createdAtUtc": "2020-07-28T23:18:14.6562474Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "20.54.34.66" + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 2 + }, + "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "zones": [ + "1", + "2" + ] + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAiXto=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "North Europe", + "properties": { + "createdAtUtc": "2020-07-28T23:18:14.6562474Z", + "disableGateway": false, + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "provisioningState": "Created", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 2 + }, + "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "zones": [ + "1", + "2" + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceInZones" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceSkuv2Service.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceSkuv2Service.json new file mode 100644 index 000000000000..7cff8ac6e3a0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceSkuv2Service.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "West US", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk" + }, + "sku": { + "name": "StandardV2", + "capacity": 1 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAA3fHM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "SystemAssigned", + "principalId": "de161222-0000-0000-0000-1caa5d9f0b0e", + "tenantId": "72f988bf-0000-0000-0000-2d7cd011db47" + }, + "location": "East US", + "properties": { + "createdAtUtc": "2023-08-10T18:50:52.5509471Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "disableGateway": false, + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "natGatewayState": "Unsupported", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "undetermined", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "publisherEmail": "apim@contoso.com", + "publisherName": "apimgmt-skuv2", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "StandardV2", + "capacity": 1 + }, + "systemData": { + "createdAt": "2023-08-10T18:50:51.539583Z", + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2023-08-10T18:50:51.539583Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User" + }, + "tags": {}, + "zones": null + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAA3h2Q=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "SystemAssigned", + "principalId": "de161222-0000-0000-0000-1caa5d9f0b0e", + "tenantId": "72f988bf-0000-0000-0000-2d7cd011db47" + }, + "location": "East US", + "properties": { + "createdAtUtc": "2023-08-11T18:24:14.7662749Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalStatus": "Disabled", + "disableGateway": false, + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "legacyPortalStatus": "Disabled", + "natGatewayState": "Unsupported", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "undetermined", + "provisioningState": "Activating", + "publicNetworkAccess": "Enabled", + "publisherEmail": "apim@contoso.com", + "publisherName": "apimgmt-skuv2", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" + }, + "sku": { + "name": "StandardV2", + "capacity": 1 + }, + "systemData": { + "createdAt": "2023-08-11T18:24:13.7820033Z", + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2023-08-11T18:24:13.7820033Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User" + }, + "tags": {}, + "zones": null + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceSkuv2Service" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithCustomHostnameKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithCustomHostnameKeyVault.json new file mode 100644 index 000000000000..562f35ba3277 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithCustomHostnameKeyVault.json @@ -0,0 +1,308 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "North Europe", + "properties": { + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, + "hostnameConfigurations": [ + { + "type": "Proxy", + "defaultSslBinding": true, + "hostName": "gateway1.msitesting.net", + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert" + }, + { + "type": "Management", + "hostName": "mgmt.msitesting.net", + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert" + }, + { + "type": "Portal", + "hostName": "portal1.msitesting.net", + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert" + }, + { + "type": "ConfigurationApi", + "certificatePassword": "Password", + "encodedCertificate": "****** Base 64 Encoded Certificate ************", + "hostName": "configuration-api.msitesting.net" + } + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAigjU=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "UserAssigned", + "tenantId": "f686d426-8d16-0000-0000-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "329419bc-adec-4dce-9568-25a6d486e468", + "principalId": "15e769b2-0000-0000-0000-3fd9a923ac3a" + } + } + }, + "location": "North Europe", + "properties": { + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, + "createdAtUtc": "2020-09-13T22:30:20.7759747Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": false, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + }, + { + "type": "Proxy", + "certificate": { + "expiry": "2037-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690" + }, + "certificateSource": "KeyVault", + "defaultSslBinding": true, + "hostName": "gateway1.msitesting.net", + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false + }, + { + "type": "Management", + "certificate": { + "expiry": "2037-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690" + }, + "certificateSource": "KeyVault", + "defaultSslBinding": false, + "hostName": "mgmt.msitesting.net", + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false + }, + { + "type": "Portal", + "certificate": { + "expiry": "2037-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690" + }, + "certificateSource": "KeyVault", + "defaultSslBinding": false, + "hostName": "portal1.msitesting.net", + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false + }, + { + "type": "ConfigurationApi", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" + }, + "defaultSslBinding": false, + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "40.112.74.192" + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAigi8=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "North Europe", + "properties": { + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, + "createdAtUtc": "2020-09-13T22:30:20.7759747Z", + "disableGateway": false, + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": false, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + }, + { + "type": "Proxy", + "certificate": { + "expiry": "2037-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690" + }, + "certificateSource": "KeyVault", + "defaultSslBinding": true, + "hostName": "gateway1.msitesting.net", + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false + }, + { + "type": "Management", + "certificate": { + "expiry": "2037-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690" + }, + "certificateSource": "KeyVault", + "defaultSslBinding": false, + "hostName": "mgmt.msitesting.net", + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false + }, + { + "type": "Portal", + "certificate": { + "expiry": "2037-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690" + }, + "certificateSource": "KeyVault", + "defaultSslBinding": false, + "hostName": "portal1.msitesting.net", + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false + }, + { + "type": "ConfigurationApi", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" + }, + "defaultSslBinding": false, + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "provisioningState": "Created", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceWithCustomHostnameKeyVault" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithDeveloperPortal.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithDeveloperPortal.json new file mode 100644 index 000000000000..3cb2b58e0801 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithDeveloperPortal.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "location": "South Central US", + "properties": { + "developerPortalStatus": "Enabled", + "publisherEmail": "foo@contoso.com", + "publisherName": "foo" + }, + "sku": { + "name": "Developer", + "capacity": 1 + }, + "tags": { + "Name": "Contoso", + "Test": "User" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAmREI=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "East US", + "properties": { + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv1", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.90.229.33" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "samir@microsoft.com", + "publisherName": "foo", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" + } + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAmRAM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "East US", + "properties": { + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "developerPortalStatus": "Enabled", + "disableGateway": false, + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "legacyPortalStatus": "Disabled", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "undetermined", + "provisioningState": "Created", + "publicNetworkAccess": "Enabled", + "publisherEmail": "samir@microsoft.com", + "publisherName": "foo", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceWithDeveloperPortal" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithNatGatewayEnabled.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithNatGatewayEnabled.json new file mode 100644 index 000000000000..a05e6ad1b200 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithNatGatewayEnabled.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "location": "East US", + "properties": { + "natGatewayState": "Enabled", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAmREI=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "East US", + "properties": { + "apiVersionConstraint": { + "minApiVersion": null + }, + "createdAtUtc": "2022-07-26T18:41:01.2506031Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "natGatewayState": "Enabled", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "outboundPublicIPAddresses": [ + "60.0.0.0/31" + ], + "platformVersion": "stv2", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.90.229.33" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" + } + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAmRAM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": null, + "location": "East US", + "properties": { + "additionalLocations": null, + "apiVersionConstraint": { + "minApiVersion": null + }, + "certificates": null, + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "disableGateway": false, + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "natGatewayState": "Enabled", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "privateEndpointConnections": null, + "privateIPAddresses": null, + "provisioningState": "Created", + "publicIpAddressId": null, + "publicNetworkAccess": "Enabled", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkConfiguration": null, + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" + }, + "zones": null + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceWithNatGatewayEnabled" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithSystemCertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithSystemCertificates.json new file mode 100644 index 000000000000..edfa70df9ef9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithSystemCertificates.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "location": "Central US", + "properties": { + "certificates": [ + { + "certificatePassword": "Password", + "encodedCertificate": "*******Base64 encoded Certificate******************", + "storeName": "CertificateAuthority" + } + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk" + }, + "sku": { + "name": "Basic", + "capacity": 1 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAp3UM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "Central US", + "properties": { + "apiVersionConstraint": {}, + "certificates": [ + { + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2" + }, + "storeName": "CertificateAuthority" + } + ], + "createdAtUtc": "2019-12-18T06:33:28.0906918Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-centralus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "40.113.223.117" + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Basic", + "capacity": 1 + }, + "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAp3TM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "Central US", + "properties": { + "apiVersionConstraint": {}, + "certificates": [ + { + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2" + }, + "storeName": "CertificateAuthority" + } + ], + "createdAtUtc": "2019-12-18T06:33:28.0906918Z", + "disableGateway": false, + "hostnameConfigurations": [ + { + "type": "Proxy", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "provisioningState": "Created", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Basic", + "capacity": 1 + }, + "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceWithSystemCertificates" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithUserAssignedIdentity.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithUserAssignedIdentity.json new file mode 100644 index 000000000000..086a15c3f4ca --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithUserAssignedIdentity.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {} + } + }, + "location": "West US", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAFzyk=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "UserAssigned", + "tenantId": "00000000-86f1-41af-0000-2d7cd011db47", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": { + "clientId": "5a2c6b8e-0905-0000-a772-993c9418137f", + "principalId": "00000000-6e62-4649-9f54-a119fc1ba85e" + } + } + }, + "location": "West US", + "properties": { + "createdAtUtc": "2020-03-12T01:05:33.4573398Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "disableGateway": false, + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "mtv1", + "provisioningState": "Succeeded", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + }, + "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAFzyQ=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {} + } + }, + "location": "West US", + "properties": { + "createdAtUtc": "2020-03-12T01:05:33.4573398Z", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "mtv1", + "provisioningState": "Created", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + }, + "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceWithUserAssignedIdentity" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithoutLegacyConfigurationApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithoutLegacyConfigurationApi.json new file mode 100644 index 000000000000..8f3da7a68d7d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateServiceWithoutLegacyConfigurationApi.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "location": "Central US", + "properties": { + "configurationApi": { + "legacyApi": "Disabled" + }, + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk" + }, + "sku": { + "name": "Basic", + "capacity": 1 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAp3UM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "Central US", + "properties": { + "apiVersionConstraint": {}, + "certificates": [], + "configurationApi": { + "legacyApi": "Disabled" + }, + "createdAtUtc": "2019-12-18T06:33:28.0906918Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-centralus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "40.113.223.117" + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Basic", + "capacity": 1 + }, + "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAp3TM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "Central US", + "properties": { + "apiVersionConstraint": {}, + "certificates": [], + "configurationApi": { + "legacyApi": "Disabled" + }, + "createdAtUtc": "2019-12-18T06:33:28.0906918Z", + "disableGateway": false, + "hostnameConfigurations": [ + { + "type": "Proxy", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "provisioningState": "Created", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Basic", + "capacity": 1 + }, + "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceWithoutLegacyConfigurationApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json new file mode 100644 index 000000000000..198253ea37f0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "soapApi", + "parameters": { + "properties": { + "format": "wsdl-link", + "path": "currency", + "apiType": "soap", + "value": "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL", + "wsdlSelector": { + "wsdlEndpointName": "CurrencyConvertorSoap", + "wsdlServiceName": "CurrencyConvertor" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", + "properties": { + "type": "soap", + "path": "currency", + "apiRevision": "1", + "displayName": "CurrencyConvertor", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://www.webservicex.net", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", + "properties": { + "type": "soap", + "path": "currency", + "apiRevision": "1", + "displayName": "CurrencyConvertor", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://www.webservicex.net", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateSoapPassThroughApiUsingWsdlImport" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateSoapToRestApiUsingWsdlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateSoapToRestApiUsingWsdlImport.json new file mode 100644 index 000000000000..1b01e15384e8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateSoapToRestApiUsingWsdlImport.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "soapApi", + "parameters": { + "properties": { + "format": "wsdl-link", + "path": "currency", + "value": "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL", + "wsdlSelector": { + "wsdlEndpointName": "CurrencyConvertorSoap", + "wsdlServiceName": "CurrencyConvertor" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", + "properties": { + "path": "currency", + "apiRevision": "1", + "displayName": "CurrencyConvertor", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://www.webservicex.net", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", + "properties": { + "path": "currency", + "apiRevision": "1", + "displayName": "CurrencyConvertor", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://www.webservicex.net", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateSoapToRestApiUsingWsdlImport" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateStandardGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateStandardGateway.json new file mode 100644 index 000000000000..2fc2feb5e9f4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateStandardGateway.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayName": "apimGateway1", + "parameters": { + "location": "South Central US", + "properties": { + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + } + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "tags": { + "Name": "Contoso", + "Test": "User" + } + }, + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimGateway1", + "type": "Microsoft.ApiManagement/gateways", + "etag": "AAAAAAAmREI=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", + "location": "East US", + "properties": { + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "configurationApi": { + "hostname": "apimGateway1.eastus.configuration.gateway.azure-api.net" + }, + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "frontend": { + "defaultHostname": "apimGateway1.eastus.gateway.azure-api.net" + }, + "provisioningState": "Succeeded", + "targetProvisioningState": "" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" + } + } + }, + "201": { + "body": { + "name": "apimGateway1", + "type": "Microsoft.ApiManagement/gateway", + "etag": "AAAAAAAmRAM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", + "location": "East US", + "properties": { + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "provisioningState": "Created", + "targetProvisioningState": "Activating" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiGateway_CreateOrUpdate", + "title": "ApiManagementCreateStandardGateway" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateSubscription.json new file mode 100644 index 000000000000..6af4c94cc49f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateSubscription.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "displayName": "testsub", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "testsub", + "type": "Microsoft.ApiManagement/service/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub", + "properties": { + "createdDate": "2017-06-02T23:34:03.1055076Z", + "displayName": "testsub", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "state": "submitted" + } + } + }, + "201": { + "body": { + "name": "testsub", + "type": "Microsoft.ApiManagement/service/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub", + "properties": { + "createdDate": "2017-06-02T23:34:03.1055076Z", + "displayName": "testsub", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "state": "submitted" + } + } + } + }, + "operationId": "Subscription_CreateOrUpdate", + "title": "ApiManagementCreateSubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTag.json new file mode 100644 index 000000000000..f7efd69b5d4a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTag.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "displayName": "tag1" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tagId1" + }, + "responses": { + "200": { + "body": { + "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "201": { + "body": { + "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "properties": { + "displayName": "tag1" + } + } + } + }, + "operationId": "Tag_CreateOrUpdate", + "title": "ApiManagementCreateTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTagApiLink.json new file mode 100644 index 000000000000..a3c5cdd162e2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTagApiLink.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + }, + "201": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + } + }, + "operationId": "TagApiLink_CreateOrUpdate", + "title": "ApiManagementCreateTagApiLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTagOperationLink.json new file mode 100644 index 000000000000..0616c0abec47 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTagOperationLink.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "operationLinkId": "link1", + "parameters": { + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" + } + } + }, + "201": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" + } + } + } + }, + "operationId": "TagOperationLink_CreateOrUpdate", + "title": "ApiManagementCreateTagOperationLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTagProductLink.json new file mode 100644 index 000000000000..82597fee7939 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTagProductLink.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" + } + }, + "productLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" + } + } + }, + "201": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" + } + } + } + }, + "operationId": "TagProductLink_CreateOrUpdate", + "title": "ApiManagementCreateTagProductLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTemplate.json new file mode 100644 index 000000000000..77f4cbc28044 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTemplate.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "subject": "Your request for $IssueName was successfully received." + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "templateName": "newIssueNotificationMessage" + }, + "responses": { + "200": { + "body": { + "name": "NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", + "properties": { + "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "isDefault": false, + "parameters": [ + { + "name": "DevFirstName", + "title": "Developer first name" + }, + { + "name": "DevLastName", + "title": "Developer last name" + }, + { + "name": "IssueId", + "title": "Issue id" + }, + { + "name": "IssueName", + "title": "Issue name" + }, + { + "name": "OrganizationName", + "title": "Organization name" + }, + { + "name": "DevPortalUrl", + "title": "Developer portal URL" + } + ], + "subject": "Your request for $IssueName was successfully received.", + "title": "New issue received" + } + } + }, + "201": { + "body": { + "name": "NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", + "properties": { + "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "isDefault": false, + "parameters": [ + { + "name": "DevFirstName", + "title": "Developer first name" + }, + { + "name": "DevLastName", + "title": "Developer last name" + }, + { + "name": "IssueId", + "title": "Issue id" + }, + { + "name": "IssueName", + "title": "Issue name" + }, + { + "name": "OrganizationName", + "title": "Organization name" + }, + { + "name": "DevPortalUrl", + "title": "Developer portal URL" + } + ], + "subject": "Your request for $IssueName was successfully received.", + "title": "New issue received" + } + } + } + }, + "operationId": "EmailTemplate_CreateOrUpdate", + "title": "ApiManagementCreateTemplate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTenantAccess.json new file mode 100644 index 000000000000..d1f8d79332cd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateTenantAccess.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "If-Match": "*", + "accessName": "access", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "enabled": true + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "access", + "type": "Microsoft.ApiManagement/service/tenant", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", + "properties": { + "enabled": true + } + } + } + }, + "operationId": "TenantAccess_Create", + "title": "ApiManagementCreateTenantAccess" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateUser.json new file mode 100644 index 000000000000..b99b2ac6d668 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateUser.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "confirmation": "signup", + "email": "foobar@outlook.com", + "firstName": "foo", + "lastName": "bar" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" + }, + "responses": { + "200": { + "body": { + "name": "5931a75ae4bbd512288c680b", + "type": "Microsoft.ApiManagement/service/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b", + "properties": { + "email": "foobar@outlook.com", + "firstName": "foo", + "groups": [], + "identities": [ + { + "id": "foobar@outlook.com", + "provider": "Basic" + } + ], + "lastName": "bar", + "registrationDate": "2018-01-07T21:21:29.16Z", + "state": "active" + } + } + }, + "201": { + "body": { + "name": "5931a75ae4bbd512288c680b", + "type": "Microsoft.ApiManagement/service/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b", + "properties": { + "email": "foobar@outlook.com", + "firstName": "foo", + "groups": [], + "identities": [ + { + "id": "foobar@outlook.com", + "provider": "Basic" + } + ], + "lastName": "bar", + "registrationDate": "2018-01-07T21:21:29.16Z", + "state": "active" + } + } + } + }, + "operationId": "User_CreateOrUpdate", + "title": "ApiManagementCreateUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWebsocketApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWebsocketApi.json new file mode 100644 index 000000000000..0b9b1c67efb4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWebsocketApi.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "tempgroup", + "parameters": { + "properties": { + "type": "websocket", + "path": "newapiPath", + "description": "apidescription5200", + "displayName": "apiname1463", + "protocols": [ + "wss", + "ws" + ], + "serviceUrl": "wss://echo.websocket.org" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "type": "websocket", + "path": "newapiPath", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": null, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "ws", + "wss" + ], + "provisioningState": "InProgress", + "serviceUrl": "wss://echo.websocket.org", + "subscriptionKeyParameterNames": null + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "type": "websocket", + "path": "newapiPath", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": null, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "ws", + "wss" + ], + "provisioningState": "InProgress", + "serviceUrl": "wss://echo.websocket.org", + "subscriptionKeyParameterNames": null + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateWebSocketApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspace.json new file mode 100644 index 000000000000..dfc243a36f3b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspace.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "description": "workspace 1", + "displayName": "my workspace" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", + "properties": { + "description": "workspace 1", + "displayName": "my workspace" + } + } + }, + "201": { + "body": { + "name": "wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", + "properties": { + "description": "workspace 1", + "displayName": "my workspace" + } + } + } + }, + "operationId": "Workspace_CreateOrUpdate", + "title": "ApiManagementCreateWorkspace" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceAILogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceAILogger.json new file mode 100644 index 000000000000..679941702ed7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceAILogger.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "loggerId": "loggerId", + "parameters": { + "properties": { + "description": "adding a new logger", + "credentials": { + "instrumentationKey": "11................a1" + }, + "loggerType": "applicationInsights" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "loggerId", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/loggerId", + "properties": { + "description": null, + "credentials": { + "instrumentationKey": "{{5a.......2a}}" + }, + "isBuffered": false, + "loggerType": "applicationInsights" + } + } + }, + "201": { + "body": { + "name": "loggerId", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/loggerId", + "properties": { + "description": null, + "credentials": { + "instrumentationKey": "{{5a.......2a}}" + }, + "isBuffered": false, + "loggerType": "applicationInsights", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.insights/components/airesource" + } + } + } + }, + "operationId": "WorkspaceLogger_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceAILogger" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApi.json new file mode 100644 index 000000000000..42aa3163efe0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApi.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "tempgroup", + "parameters": { + "properties": { + "path": "newapiPath", + "description": "apidescription5200", + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + }, + "displayName": "apiname1463", + "protocols": [ + "https", + "http" + ], + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/apiid9419", + "properties": { + "path": "newapiPath", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + ] + }, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/apiid9419", + "properties": { + "path": "newapiPath", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + ] + }, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "WorkspaceApi_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiDiagnostic.json new file mode 100644 index 000000000000..19d668b46900 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiDiagnostic.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "diagnosticId": "applicationinsights", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + } + }, + "201": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + } + } + }, + "operationId": "WorkspaceApiDiagnostic_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApiDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiOperation.json new file mode 100644 index 000000000000..b21e49aa9a7d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiOperation.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "operationId": "newoperations", + "api-version": "2024-10-01-preview", + "apiId": "PetStoreTemplate2", + "parameters": { + "properties": { + "method": "POST", + "description": "This can only be done by the logged in user.", + "displayName": "createUser2", + "templateParameters": [], + "urlTemplate": "/user1", + "request": { + "description": "Created user object", + "headers": [], + "queryParameters": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "description": "successful operation", + "headers": [], + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "statusCode": 200 + } + ] + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "newoperations", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/PetStoreTemplate2/operations/newoperations", + "properties": { + "method": "POST", + "description": "This can only be done by the logged in user.", + "displayName": "createUser2", + "templateParameters": [], + "urlTemplate": "/user1", + "request": { + "description": "Created user object", + "headers": [], + "queryParameters": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "description": "successful operation", + "headers": [], + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "statusCode": 200 + } + ] + } + } + }, + "201": { + "body": { + "name": "newoperations", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/PetStoreTemplate2/operations/newoperations", + "properties": { + "method": "POST", + "description": "This can only be done by the logged in user.", + "displayName": "createUser2", + "templateParameters": [], + "urlTemplate": "/user1", + "request": { + "description": "Created user object", + "headers": [], + "queryParameters": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "description": "successful operation", + "headers": [], + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "statusCode": 200 + } + ] + } + } + } + }, + "operationId": "WorkspaceApiOperation_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApiOperation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiOperationPolicy.json new file mode 100644 index 000000000000..ada756ba9a62 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiOperationPolicy.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "operationId": "5600b57e7e8880006a080001", + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "5600b57e7e8880006a040001", + "parameters": { + "properties": { + "format": "xml", + "value": " " + } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "201": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "WorkspaceApiOperationPolicy_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApiOperationPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiPolicy.json new file mode 100644 index 000000000000..329d6ccef84c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiPolicy.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "5600b57e7e8880006a040001", + "parameters": { + "properties": { + "format": "xml", + "value": " " + } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "201": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "WorkspaceApiPolicy_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApiPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiRelease.json new file mode 100644 index 000000000000..70e353a18d81 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiRelease.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "a1", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", + "notes": "yahooagain" + } + }, + "releaseId": "testrev", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "testrev", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/testrev", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", + "createdDateTime": "2018-02-08T20:52:00.65Z", + "notes": "yahooagain", + "updatedDateTime": "2018-02-08T20:52:00.65Z" + } + } + }, + "201": { + "body": { + "name": "testrev", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/testrev", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", + "createdDateTime": "2018-02-08T20:52:00.65Z", + "notes": "yahooagain", + "updatedDateTime": "2018-02-08T20:52:00.65Z" + } + } + } + }, + "operationId": "WorkspaceApiRelease_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApiRelease" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiSchema.json new file mode 100644 index 000000000000..cedc322d08f7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiSchema.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "parameters": { + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "resourceGroupName": "rg1", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + }, + "provisioningState": "InProgress" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + }, + "provisioningState": "InProgress" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "WorkspaceApiSchema_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApiSchema" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiVersionSet.json new file mode 100644 index 000000000000..2df78f917034 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceApiVersionSet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "description": "Version configuration", + "displayName": "api set 1", + "versioningScheme": "Segment" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "api1", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "api1", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/api1", + "properties": { + "description": "Version configuration", + "displayName": "api set 1", + "versioningScheme": "Segment" + } + } + }, + "201": { + "body": { + "name": "api1", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/api1", + "properties": { + "description": "Version configuration", + "displayName": "api set 1", + "versioningScheme": "Segment" + } + } + } + }, + "operationId": "WorkspaceApiVersionSet_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApiVersionSet" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceBackendProxyBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceBackendProxyBackend.json new file mode 100644 index 000000000000..c8dd46180925 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceBackendProxyBackend.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "backendId": "proxybackend", + "parameters": { + "properties": { + "description": "description5308", + "credentials": { + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + } + }, + "proxy": { + "password": "", + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin" + }, + "tls": { + "validateCertificateChain": true, + "validateCertificateName": true + }, + "url": "https://backendname2644/", + "protocol": "http" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", + "properties": { + "description": "description5308", + "credentials": { + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + } + }, + "proxy": { + "password": "", + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + }, + "url": "https://backendname2644/", + "protocol": "http" + } + } + }, + "201": { + "body": { + "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", + "properties": { + "description": "description5308", + "credentials": { + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + } + }, + "proxy": { + "password": "", + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + }, + "url": "https://backendname2644/", + "protocol": "http" + } + } + } + }, + "operationId": "WorkspaceBackend_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceBackendProxyBackend" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceBackendServiceFabric.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceBackendServiceFabric.json new file mode 100644 index 000000000000..6399898dba93 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceBackendServiceFabric.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "backendId": "sfbackend", + "parameters": { + "properties": { + "description": "Service Fabric Test App 1", + "properties": { + "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "managementEndpoints": [ + "https://somecluster.com" + ], + "maxPartitionResolutionRetries": 5, + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ] + } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "properties": { + "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "managementEndpoints": [ + "https://somecluster.com" + ], + "maxPartitionResolutionRetries": 5, + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ] + } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" + } + } + }, + "201": { + "body": { + "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "properties": { + "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "managementEndpoints": [ + "https://somecluster.com" + ], + "maxPartitionResolutionRetries": 5, + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ] + } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" + } + } + } + }, + "operationId": "WorkspaceBackend_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceBackendServiceFabric" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceCertificate.json new file mode 100644 index 000000000000..ebda732989ab --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceCertificate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "tempcert", + "parameters": { + "properties": { + "data": "****************Base 64 Encoded Certificate *******************************", + "password": "****Certificate Password******" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "tempcert", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/tempcert", + "properties": { + "expirationDate": "2018-03-17T21:55:07+00:00", + "subject": "CN=contoso.com", + "thumbprint": "*******************3" + } + } + }, + "201": { + "body": { + "name": "tempcert", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/tempcert", + "properties": { + "expirationDate": "2018-03-17T21:55:07+00:00", + "subject": "CN=contoso.com", + "thumbprint": "*******************3" + } + } + } + }, + "operationId": "WorkspaceCertificate_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceCertificate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceCertificateWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceCertificateWithKeyVault.json new file mode 100644 index 000000000000..04c2c35a61b2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceCertificateWithKeyVault.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "templateCertkv", + "parameters": { + "properties": { + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", + "properties": { + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" + } + } + }, + "201": { + "body": { + "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", + "properties": { + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" + } + } + } + }, + "operationId": "WorkspaceCertificate_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceCertificateWithKeyVault" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceDiagnostic.json new file mode 100644 index 000000000000..2ed205f552bf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceDiagnostic.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "diagnosticId": "applicationinsights", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/workspaces/wks1/loggers/azuremonitor", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + } + }, + "201": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/workspaces/wks1/loggers/azuremonitor", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + } + } + }, + "operationId": "WorkspaceDiagnostic_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceEHLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceEHLogger.json new file mode 100644 index 000000000000..cfb795ea35be --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceEHLogger.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "loggerId": "eh1", + "parameters": { + "properties": { + "description": "adding a new logger", + "credentials": { + "name": "hydraeventhub", + "connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********=" + }, + "loggerType": "azureEventHub" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "eh1", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1", + "properties": { + "description": "adding a new logger", + "credentials": { + "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" + }, + "isBuffered": true, + "loggerType": "azureEventHub" + } + } + }, + "201": { + "body": { + "name": "eh1", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1", + "properties": { + "description": "adding a new logger", + "credentials": { + "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" + }, + "isBuffered": true, + "loggerType": "azureEventHub" + } + } + } + }, + "operationId": "WorkspaceLogger_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceEHLogger" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceGroup.json new file mode 100644 index 000000000000..d52eb92dfc40 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "tempgroup", + "parameters": { + "properties": { + "displayName": "temp group" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "tempgroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup", + "properties": { + "type": "custom", + "displayName": "temp group" + } + } + }, + "201": { + "body": { + "name": "tempgroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup", + "properties": { + "type": "custom", + "displayName": "temp group" + } + } + } + }, + "operationId": "WorkspaceGroup_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceGroupExternal.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceGroupExternal.json new file mode 100644 index 000000000000..29cbb35af993 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceGroupExternal.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "aadGroup", + "parameters": { + "properties": { + "type": "external", + "description": "new group to test", + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "aadGroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/aadGroup", + "properties": { + "type": "external", + "description": "new group to test", + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + } + }, + "201": { + "body": { + "name": "aadGroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/aadGroup", + "properties": { + "type": "external", + "description": "new group to test", + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + } + } + }, + "operationId": "WorkspaceGroup_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceGroupExternal" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceGroupUser.json new file mode 100644 index 000000000000..aa62c8ff5c5b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceGroupUser.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "tempgroup", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "59307d350af58404d8a26300", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "59307d350af58404d8a26300", + "type": "Microsoft.ApiManagement/service/workspaces/groups/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/59307d350af58404d8a26300", + "properties": { + "email": "testuser1@live.com", + "firstName": "test", + "groups": [], + "identities": [], + "lastName": "user", + "registrationDate": "2017-06-01T20:46:45.437Z", + "state": "active" + } + } + }, + "201": { + "body": { + "name": "59307d350af58404d8a26300", + "type": "Microsoft.ApiManagement/service/workspaces/groups/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/59307d350af58404d8a26300", + "properties": { + "email": "testuser1@live.com", + "firstName": "test", + "groups": [], + "identities": [], + "lastName": "user", + "registrationDate": "2017-06-01T20:46:45.437Z", + "state": "active" + } + } + } + }, + "operationId": "WorkspaceGroupUser_Create", + "title": "ApiManagementCreateWorkspaceGroupUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNamedValue.json new file mode 100644 index 000000000000..a8e2bd35fb50 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNamedValue.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "namedValueId": "testprop2", + "parameters": { + "properties": { + "displayName": "prop3name", + "secret": false, + "tags": [ + "foo", + "bar" + ], + "value": "propValue" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "testprop2", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2", + "properties": { + "displayName": "prop3name", + "provisioningState": "InProgress", + "secret": false, + "tags": [ + "foo", + "bar" + ], + "value": "propValue" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "testprop2", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2", + "properties": { + "displayName": "prop3name", + "provisioningState": "InProgress", + "secret": false, + "tags": [ + "foo", + "bar" + ], + "value": "propValue" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "WorkspaceNamedValue_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceNamedValue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json new file mode 100644 index 000000000000..de1cd051edb6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "namedValueId": "testprop6", + "parameters": { + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" + }, + "secret": true, + "tags": [ + "foo", + "bar" + ] + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "testprop6", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + }, + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" + }, + "provisioningState": "InProgress", + "secret": true, + "tags": [ + "foo", + "bar" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "testprop6", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + }, + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" + }, + "provisioningState": "InProgress", + "secret": true, + "tags": [ + "foo", + "bar" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "WorkspaceNamedValue_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceNamedValueWithKeyVault" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNotification.json new file mode 100644 index 000000000000..5cc0fa7de327 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNotification.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/workspaces/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage", + "properties": { + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + }, + "title": "Subscription requests (requiring approval)" + } + } + } + }, + "operationId": "WorkspaceNotification_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceNotification" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNotificationRecipientEmail.json new file mode 100644 index 000000000000..93b302b68e7c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNotificationRecipientEmail.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "email": "foobar@live.com", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "foobar@live.com", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + }, + "201": { + "body": { + "name": "foobar@live.com", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + } + }, + "operationId": "WorkspaceNotificationRecipientEmail_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceNotificationRecipientEmail" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNotificationRecipientUser.json new file mode 100644 index 000000000000..a0928cb90886 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceNotificationRecipientUser.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "576823d0a40f7e74ec07d642", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientUsers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + }, + "201": { + "body": { + "name": "576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientUsers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + } + }, + "operationId": "WorkspaceNotificationRecipientUser_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceNotificationRecipientUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspacePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspacePolicy.json new file mode 100644 index 000000000000..ef6dc56eb1e9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspacePolicy.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "format": "xml", + "value": " " + } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "201": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "WorkspacePolicy_CreateOrUpdate", + "title": "ApiManagementCreateWorkspacePolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspacePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspacePolicyFragment.json new file mode 100644 index 000000000000..b853fb2d30d0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspacePolicyFragment.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "parameters": { + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "provisioningState": "InProgress", + "value": "" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + }, + "201": { + "body": { + "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "provisioningState": "InProgress", + "value": "" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + } + }, + "operationId": "WorkspacePolicyFragment_CreateOrUpdate", + "title": "ApiManagementCreateWorkspacePolicyFragment" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspacePolicyNonXmlEncoded.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspacePolicyNonXmlEncoded.json new file mode 100644 index 000000000000..ce88879f908e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspacePolicyNonXmlEncoded.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "format": "rawxml", + "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n " + } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n" + } + } + }, + "201": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n" + } + } + } + }, + "operationId": "WorkspacePolicy_CreateOrUpdate", + "title": "ApiManagementCreateWorkspacePolicyNonXmlEncoded" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspacePremiumGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspacePremiumGateway.json new file mode 100644 index 000000000000..4a85e3ae6f4c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspacePremiumGateway.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayName": "apimGateway1", + "parameters": { + "location": "South Central US", + "properties": { + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "WorkspaceGatewayPremium", + "capacity": 1 + }, + "tags": { + "Name": "Contoso", + "Test": "User" + } + }, + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimGateway1", + "type": "Microsoft.ApiManagement/gateways", + "etag": "AAAAAAAmREI=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", + "location": "East US", + "properties": { + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "virtualNetworkType": "External" + }, + "sku": { + "name": "WorkspaceGatewayPremium", + "capacity": 1 + }, + "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" + } + } + }, + "201": { + "body": { + "name": "apimGateway1", + "type": "Microsoft.ApiManagement/gateway", + "etag": "AAAAAAAmRAM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", + "location": "East US", + "properties": { + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "virtualNetworkType": "External" + }, + "sku": { + "name": "WorkspaceGatewayPremium", + "capacity": 1 + }, + "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiGateway_CreateOrUpdate", + "title": "ApiManagementCreateWorkspacePremiumGateway" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceProduct.json new file mode 100644 index 000000000000..bd5711592f12 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceProduct.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "displayName": "Test Template ProductName 4" + } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "testproduct", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct", + "properties": { + "approvalRequired": false, + "displayName": "Test Template ProductName 4", + "state": "notPublished", + "subscriptionRequired": true + } + } + }, + "201": { + "body": { + "name": "testproduct", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct", + "properties": { + "approvalRequired": false, + "displayName": "Test Template ProductName 4", + "state": "notPublished", + "subscriptionRequired": true + } + } + } + }, + "operationId": "WorkspaceProduct_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceProduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceProductApiLink.json new file mode 100644 index 000000000000..b14eecb23a98 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceProductApiLink.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + }, + "201": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + } + }, + "operationId": "WorkspaceProductApiLink_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceProductApiLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceProductGroupLink.json new file mode 100644 index 000000000000..aa5781f42928 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceProductGroupLink.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupLinkId": "link1", + "parameters": { + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" + } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/groupLinkId", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/groupLinkId/link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" + } + } + }, + "201": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/groupLinkId", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/groupLinkId/link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" + } + } + } + }, + "operationId": "WorkspaceProductGroupLink_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceProductGroupLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceProductPolicy.json new file mode 100644 index 000000000000..92f90034c541 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceProductPolicy.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "format": "xml", + "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + }, + "policyId": "policy", + "productId": "5702e97e5157a50f48dce801", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5702e97e5157a50f48dce801/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "201": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5702e97e5157a50f48dce801/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "WorkspaceProductPolicy_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceProductPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceSchema.json new file mode 100644 index 000000000000..113b4841f7e6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceSchema.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + }, + "resourceGroupName": "rg1", + "schemaId": "schema1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "schema1", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", + "properties": { + "description": "sample schema description", + "provisioningState": "InProgress", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "schema1", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", + "properties": { + "description": "sample schema description", + "provisioningState": "InProgress", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "WorkspaceGlobalSchema_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceSchema" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceSubscription.json new file mode 100644 index 000000000000..2f77dca84cce --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceSubscription.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "displayName": "testsub", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "testsub", + "type": "Microsoft.ApiManagement/service/workspaces.subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub", + "properties": { + "createdDate": "2017-06-02T23:34:03.1055076Z", + "displayName": "testsub", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", + "state": "submitted" + } + } + }, + "201": { + "body": { + "name": "testsub", + "type": "Microsoft.ApiManagement/service/workspaces.subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub", + "properties": { + "createdDate": "2017-06-02T23:34:03.1055076Z", + "displayName": "testsub", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", + "state": "submitted" + } + } + } + }, + "operationId": "WorkspaceSubscription_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceSubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceTag.json new file mode 100644 index 000000000000..a0142a6959d9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceTag.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "displayName": "tag1" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tagId1", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "tagId1", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "201": { + "body": { + "name": "tagId1", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tagId1", + "properties": { + "displayName": "tag1" + } + } + } + }, + "operationId": "WorkspaceTag_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceTagApiLink.json new file mode 100644 index 000000000000..c4b48100dd35 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceTagApiLink.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + }, + "201": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + } + }, + "operationId": "WorkspaceTagApiLink_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceTagApiLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceTagOperationLink.json new file mode 100644 index 000000000000..141932e13eb2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceTagOperationLink.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "operationLinkId": "link1", + "parameters": { + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" + } + } + }, + "201": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" + } + } + } + }, + "operationId": "WorkspaceTagOperationLink_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceTagOperationLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceTagProductLink.json new file mode 100644 index 000000000000..37217fdbe109 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementCreateWorkspaceTagProductLink.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" + } + }, + "productLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" + } + } + }, + "201": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" + } + } + } + }, + "operationId": "WorkspaceTagProductLink_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceTagProductLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApi.json new file mode 100644 index 000000000000..320e16ae32c0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApi.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512288c680b?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=204" + } + }, + "204": {} + }, + "operationId": "Api_Delete", + "title": "ApiManagementDeleteApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiDiagnostic.json new file mode 100644 index 000000000000..6780346d0d1f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiDiagnostic.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ApiDiagnostic_Delete", + "title": "ApiManagementDeleteApiDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiIssue.json new file mode 100644 index 000000000000..48b5078cbf7b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiIssue.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ApiIssue_Delete", + "title": "ApiManagementDeleteApiIssue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiIssueAttachment.json new file mode 100644 index 000000000000..971fa6f188d6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiIssueAttachment.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "attachmentId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ApiIssueAttachment_Delete", + "title": "ApiManagementDeleteApiIssueAttachment" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiIssueComment.json new file mode 100644 index 000000000000..5e9d41eab2a1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiIssueComment.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "commentId": "599e29ab193c3c0bd0b3e2fb", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ApiIssueComment_Delete", + "title": "ApiManagementDeleteApiIssueComment" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiOperation.json new file mode 100644 index 000000000000..fd8135b99042 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiOperation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "operationId": "57d2ef278aa04f0ad01d6cdc", + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ApiOperation_Delete", + "title": "ApiManagementDeleteApiOperation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiOperationPolicy.json new file mode 100644 index 000000000000..16ed5266cd7e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiOperationPolicy.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "operationId": "testoperation", + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "testapi", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ApiOperationPolicy_Delete", + "title": "ApiManagementDeleteApiOperationPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiOperationTag.json new file mode 100644 index 000000000000..51c308db929b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiOperationTag.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "operationId": "59d5b28d1f7fab116c282651", + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "59d5b28d1f7fab116c282650", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59d5b28e1f7fab116402044e" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Tag_DetachFromOperation", + "title": "ApiManagementDeleteApiOperationTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiPolicy.json new file mode 100644 index 000000000000..af3698c77265 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiPolicy.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "loggerId", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ApiPolicy_Delete", + "title": "ApiManagementDeleteApiPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiRelease.json new file mode 100644 index 000000000000..a45d62bc04a3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiRelease.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "5a5fcc09124a7fa9b89f2f1d", + "releaseId": "testrev", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ApiRelease_Delete", + "title": "ApiManagementDeleteApiRelease" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiSchema.json new file mode 100644 index 000000000000..b2c1db7c15ca --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiSchema.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "59d5b28d1f7fab116c282650", + "resourceGroupName": "rg1", + "schemaId": "59d5b28e1f7fab116402044e", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ApiSchema_Delete", + "title": "ApiManagementDeleteApiSchema" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiTag.json new file mode 100644 index 000000000000..cd088d6a86a4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiTag.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "59d5b28d1f7fab116c282650", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59d5b28e1f7fab116402044e" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Tag_DetachFromApi", + "title": "ApiManagementDeleteApiTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiTagDescription.json new file mode 100644 index 000000000000..211c3abb68bb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiTagDescription.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "59d5b28d1f7fab116c282650", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagDescriptionId": "59d5b28e1f7fab116402044e" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ApiTagDescription_Delete", + "title": "ApiManagementDeleteApiTagDescription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiVersionSet.json new file mode 100644 index 000000000000..f36e64d4bb80 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiVersionSet.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "a1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ApiVersionSet_Delete", + "title": "ApiManagementDeleteApiVersionSet" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiWiki.json new file mode 100644 index 000000000000..e74c947a6090 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteApiWiki.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ApiWiki_Delete", + "title": "ApiManagementDeleteApiWiki" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteAuthorization.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteAuthorization.json new file mode 100644 index 000000000000..d27824f9c000 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteAuthorization.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "authorizationId": "authz1", + "authorizationProviderId": "aadwithauthcode", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Authorization_Delete", + "title": "ApiManagementDeleteAuthorization" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteAuthorizationAccessPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteAuthorizationAccessPolicy.json new file mode 100644 index 000000000000..927d249b660b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteAuthorizationAccessPolicy.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "authorizationAccessPolicyId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "authorizationId": "authz1", + "authorizationProviderId": "aadwithauthcode", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "AuthorizationAccessPolicy_Delete", + "title": "ApiManagementDeleteAuthorizationAccessPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteAuthorizationProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteAuthorizationProvider.json new file mode 100644 index 000000000000..c2e55e99bc21 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteAuthorizationProvider.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "authorizationProviderId": "aadwithauthcode", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "AuthorizationProvider_Delete", + "title": "ApiManagementDeleteAuthorizationProvider" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteAuthorizationServer.json new file mode 100644 index 000000000000..de1da843239a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteAuthorizationServer.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "authsid": "newauthServer2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "AuthorizationServer_Delete", + "title": "ApiManagementDeleteAuthorizationServer" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteBackend.json new file mode 100644 index 000000000000..b690ce8fa5ef --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteBackend.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "backendId": "sfbackend", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Backend_Delete", + "title": "ApiManagementDeleteBackend" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteCache.json new file mode 100644 index 000000000000..30623b9151ce --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteCache.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "cacheId": "southindia", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Cache_Delete", + "title": "ApiManagementDeleteCache" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteCertificate.json new file mode 100644 index 000000000000..b631a3e58ff1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteCertificate.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "certificateId": "tempcert", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Certificate_Delete", + "title": "ApiManagementDeleteCertificate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteClientApplication.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteClientApplication.json new file mode 100644 index 000000000000..a3b4cea96eb6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteClientApplication.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "clientApplicationId": "testAppId", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ClientApplication_Delete", + "title": "ApiManagementDeleteProduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteClientApplicationProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteClientApplicationProductLink.json new file mode 100644 index 000000000000..d70c766e9df7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteClientApplicationProductLink.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "clientApplicationId": "testAppId", + "clientApplicationProductLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ClientApplicationProductLink_Delete", + "title": "ApiManagementDeleteClientApplicationProductLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteContentType.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteContentType.json new file mode 100644 index 000000000000..5e48036adbeb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteContentType.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "contentTypeId": "page", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ContentType_Delete", + "title": "ApiManagementDeleteContentType" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteContentTypeContentItem.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteContentTypeContentItem.json new file mode 100644 index 000000000000..e4718b60fc7b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteContentTypeContentItem.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "contentTypeId": "page", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ContentItem_Delete", + "title": "ApiManagementDeleteContentTypeContentItem" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteDiagnostic.json new file mode 100644 index 000000000000..4ad0729158c6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteDiagnostic.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Diagnostic_Delete", + "title": "ApiManagementDeleteDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteDocumentation.json new file mode 100644 index 000000000000..3dfd3873b1e1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteDocumentation.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "documentationId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Documentation_Delete", + "title": "ApiManagementDeleteDocumentation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGateway.json new file mode 100644 index 000000000000..29e3a9841073 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGateway.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Gateway_Delete", + "title": "ApiManagementDeleteGateway" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGatewayApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGatewayApi.json new file mode 100644 index 000000000000..fc0fedd81b8c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGatewayApi.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "GatewayApi_Delete", + "title": "ApiManagementDeleteGatewayApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGatewayCertificateAuthority.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGatewayCertificateAuthority.json new file mode 100644 index 000000000000..f192dc606d1d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGatewayCertificateAuthority.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "certificateId": "default", + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "GatewayCertificateAuthority_Delete", + "title": "ApiManagementDeleteGatewayCertificateAuthority" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGatewayConfigConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGatewayConfigConnection.json new file mode 100644 index 000000000000..5e2f24e5c347 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGatewayConfigConnection.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "configConnectionName": "gcc-01", + "gatewayName": "standard-gw-01", + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-01?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-01?api-version=2024-10-01-preview" + } + }, + "204": {} + }, + "operationId": "ApiGatewayConfigConnection_Delete", + "title": "ApiManagementGatewayDeleteGateway" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGatewayHostnameConfiguration.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGatewayHostnameConfiguration.json new file mode 100644 index 000000000000..7929e9685851 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGatewayHostnameConfiguration.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "hcId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "GatewayHostnameConfiguration_Delete", + "title": "ApiManagementDeleteGatewayHostnameConfiguration" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGlobalSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGlobalSchema.json new file mode 100644 index 000000000000..a7fbcd5362d7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGlobalSchema.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "schemaId": "schema1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "GlobalSchema_Delete", + "title": "ApiManagementDeleteSchema" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGraphQLApiResolver.json new file mode 100644 index 000000000000..2a84b14fd6d1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGraphQLApiResolver.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resolverId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "GraphQLApiResolver_Delete", + "title": "ApiManagementDeleteGraphQLApiResolver" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGraphQLApiResolverPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGraphQLApiResolverPolicy.json new file mode 100644 index 000000000000..4f755bfb065b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGraphQLApiResolverPolicy.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "testapi", + "policyId": "policy", + "resolverId": "testResolver", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "GraphQLApiResolverPolicy_Delete", + "title": "ApiManagementDeleteGraphQLApiResolverPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGroup.json new file mode 100644 index 000000000000..3b9cc07593c2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGroup.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "groupId": "aadGroup", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Group_Delete", + "title": "ApiManagementDeleteGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGroupUser.json new file mode 100644 index 000000000000..77dac2a77833 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteGroupUser.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "groupId": "templategroup", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "59307d350af58404d8a26300" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "GroupUser_Delete", + "title": "ApiManagementDeleteGroupUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteIdentityProvider.json new file mode 100644 index 000000000000..081383933eee --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteIdentityProvider.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "identityProviderName": "aad", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "IdentityProvider_Delete", + "title": "ApiManagementDeleteIdentityProvider" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteLogger.json new file mode 100644 index 000000000000..e128130a31be --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteLogger.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "loggerId": "loggerId", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Logger_Delete", + "title": "ApiManagementDeleteLogger" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteNamedValue.json new file mode 100644 index 000000000000..b314bad1665e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteNamedValue.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "namedValueId": "testprop2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "NamedValue_Delete", + "title": "ApiManagementDeleteNamedValue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteNotificationRecipientEmail.json new file mode 100644 index 000000000000..1fa2004cf83a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteNotificationRecipientEmail.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "email": "contoso@live.com", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "NotificationRecipientEmail_Delete", + "title": "ApiManagementDeleteNotificationRecipientEmail" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteNotificationRecipientUser.json new file mode 100644 index 000000000000..4f6afb68f03f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteNotificationRecipientUser.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "576823d0a40f7e74ec07d642" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "NotificationRecipientUser_Delete", + "title": "ApiManagementDeleteNotificationRecipientUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteOpenIdConnectProvider.json new file mode 100644 index 000000000000..a63b2310707e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteOpenIdConnectProvider.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "opid": "templateOpenIdConnect3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "OpenIdConnectProvider_Delete", + "title": "ApiManagementDeleteOpenIdConnectProvider" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletePolicy.json new file mode 100644 index 000000000000..e3cc37aed034 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletePolicy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Policy_Delete", + "title": "ApiManagementDeletePolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletePolicyFragment.json new file mode 100644 index 000000000000..82dc382479f0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletePolicyFragment.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "PolicyFragment_Delete", + "title": "ApiManagementDeletePolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletePolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletePolicyRestriction.json new file mode 100644 index 000000000000..9ddda353c2ff --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletePolicyRestriction.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "policyRestrictionId": "policyRestriction1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "PolicyRestriction_Delete", + "title": "ApiManagementDeletePolicyRestriction" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletePrivateEndpointConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..40818f4fea47 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletePrivateEndpointConnection.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + }, + "204": {} + }, + "operationId": "PrivateEndpointConnection_Delete", + "title": "ApiManagementDeletePrivateEndpointConnection" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProduct.json new file mode 100644 index 000000000000..78104cdf6b2a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProduct.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "deleteSubscriptions": true, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Product_Delete", + "title": "ApiManagementDeleteProduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductApi.json new file mode 100644 index 000000000000..e14426b62872 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductApi.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ProductApi_Delete", + "title": "ApiManagementDeleteProductApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductApiLink.json new file mode 100644 index 000000000000..83286ef46180 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductApiLink.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ProductApiLink_Delete", + "title": "ApiManagementDeleteProductApiLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductGroup.json new file mode 100644 index 000000000000..9f1bc8cb667a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductGroup.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "groupId": "templateGroup", + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ProductGroup_Delete", + "title": "ApiManagementDeleteProductGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductGroupLink.json new file mode 100644 index 000000000000..97c9bb2c0bef --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductGroupLink.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupLinkId": "link1", + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ProductGroupLink_Delete", + "title": "ApiManagementDeleteProductGroupLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductPolicy.json new file mode 100644 index 000000000000..28b765697bf9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductPolicy.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "policyId": "policy", + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ProductPolicy_Delete", + "title": "ApiManagementDeleteProductPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductTag.json new file mode 100644 index 000000000000..c51df84acf12 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductTag.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "productId": "59d5b28d1f7fab116c282650", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59d5b28e1f7fab116402044e" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Tag_DetachFromProduct", + "title": "ApiManagementDeleteProductTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductWiki.json new file mode 100644 index 000000000000..fed07474a18c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteProductWiki.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "productId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ProductWiki_Delete", + "title": "ApiManagementDeleteProductWiki" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteSubscription.json new file mode 100644 index 000000000000..bbd2b827b747 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteSubscription.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Subscription_Delete", + "title": "ApiManagementDeleteSubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTag.json new file mode 100644 index 000000000000..f177612ab227 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTag.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tagId1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Tag_Delete", + "title": "ApiManagementDeleteTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTagApiLink.json new file mode 100644 index 000000000000..10daf8c33663 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTagApiLink.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "TagApiLink_Delete", + "title": "ApiManagementDeleteTagApiLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTagOperationLink.json new file mode 100644 index 000000000000..837465e7c933 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTagOperationLink.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "operationLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "TagOperationLink_Delete", + "title": "ApiManagementDeleteTagOperationLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTagProductLink.json new file mode 100644 index 000000000000..225a26b3ff0d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTagProductLink.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "TagProductLink_Delete", + "title": "ApiManagementDeleteTagProductLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTemplate.json new file mode 100644 index 000000000000..2d9650e512c4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteTemplate.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "templateName": "newIssueNotificationMessage" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "EmailTemplate_Delete", + "title": "ApiManagementDeleteTemplate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteUser.json new file mode 100644 index 000000000000..b1db40c4ca51 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteUser.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=204" + } + }, + "204": {} + }, + "operationId": "User_Delete", + "title": "ApiManagementDeleteUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspace.json new file mode 100644 index 000000000000..efc10ec3ab01 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspace.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Workspace_Delete", + "title": "ApiManagementDeleteWorkspace" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApi.json new file mode 100644 index 000000000000..1ea74daceca1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApi.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceApi_Delete", + "title": "ApiManagementDeleteWorkspaceApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiDiagnostic.json new file mode 100644 index 000000000000..3d32518f6d4b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiDiagnostic.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceApiDiagnostic_Delete", + "title": "ApiManagementDeleteWorkspaceApiDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiOperation.json new file mode 100644 index 000000000000..12ea3ca102d4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiOperation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "operationId": "57d2ef278aa04f0ad01d6cdc", + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceApiOperation_Delete", + "title": "ApiManagementDeleteWorkspaceApiOperation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiOperationPolicy.json new file mode 100644 index 000000000000..42d81cbcd4d1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiOperationPolicy.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "operationId": "testoperation", + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "testapi", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceApiOperationPolicy_Delete", + "title": "ApiManagementDeleteWorkspaceApiOperationPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiPolicy.json new file mode 100644 index 000000000000..c0df716e5225 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiPolicy.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "loggerId", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceApiPolicy_Delete", + "title": "ApiManagementDeleteWorkspaceApiPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiRelease.json new file mode 100644 index 000000000000..0b8e52277a51 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiRelease.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "5a5fcc09124a7fa9b89f2f1d", + "releaseId": "testrev", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceApiRelease_Delete", + "title": "ApiManagementDeleteWorkspaceApiRelease" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiSchema.json new file mode 100644 index 000000000000..d51670f08ae7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiSchema.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "59d5b28d1f7fab116c282650", + "resourceGroupName": "rg1", + "schemaId": "59d5b28e1f7fab116402044e", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceApiSchema_Delete", + "title": "ApiManagementDeleteWorkspaceApiSchema" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiVersionSet.json new file mode 100644 index 000000000000..0b23a07921bd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceApiVersionSet.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "a1", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceApiVersionSet_Delete", + "title": "ApiManagementDeleteWorkspaceApiVersionSet" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceBackend.json new file mode 100644 index 000000000000..b8350ee2c415 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceBackend.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "backendId": "sfbackend", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceBackend_Delete", + "title": "ApiManagementDeleteWorkspaceBackend" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceCertificate.json new file mode 100644 index 000000000000..29ce348268c6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceCertificate.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "certificateId": "tempcert", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceCertificate_Delete", + "title": "ApiManagementDeleteWorkspaceCertificate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceDiagnostic.json new file mode 100644 index 000000000000..ec3ebcc9b25f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceDiagnostic.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceDiagnostic_Delete", + "title": "ApiManagementDeleteWorkspaceDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceGroup.json new file mode 100644 index 000000000000..bfe9667f003a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceGroup.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "groupId": "aadGroup", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceGroup_Delete", + "title": "ApiManagementDeleteWorkspaceGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceGroupUser.json new file mode 100644 index 000000000000..9d7770098be2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceGroupUser.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "groupId": "templategroup", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "59307d350af58404d8a26300", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceGroupUser_Delete", + "title": "ApiManagementDeleteWorkspaceGroupUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceLogger.json new file mode 100644 index 000000000000..b6c21be64890 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceLogger.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "loggerId": "loggerId", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceLogger_Delete", + "title": "ApiManagementDeleteWorkspaceLogger" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceNamedValue.json new file mode 100644 index 000000000000..2e8b804d34af --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceNamedValue.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "namedValueId": "testprop2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceNamedValue_Delete", + "title": "ApiManagementDeleteWorkspaceNamedValue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceNotificationRecipientEmail.json new file mode 100644 index 000000000000..24c1acd7f7f9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceNotificationRecipientEmail.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "email": "contoso@live.com", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceNotificationRecipientEmail_Delete", + "title": "ApiManagementDeleteWorkspaceNotificationRecipientEmail" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceNotificationRecipientUser.json new file mode 100644 index 000000000000..c3ddb6b2eea0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceNotificationRecipientUser.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "576823d0a40f7e74ec07d642", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceNotificationRecipientUser_Delete", + "title": "ApiManagementDeleteWorkspaceNotificationRecipientUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspacePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspacePolicy.json new file mode 100644 index 000000000000..e793b28e4f35 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspacePolicy.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspacePolicy_Delete", + "title": "ApiManagementDeleteWorkspacePolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspacePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspacePolicyFragment.json new file mode 100644 index 000000000000..5143e6e08455 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspacePolicyFragment.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspacePolicyFragment_Delete", + "title": "ApiManagementDeleteWorkspacePolicyFragment" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceProduct.json new file mode 100644 index 000000000000..7f9fe7fd6e6b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceProduct.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "deleteSubscriptions": true, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceProduct_Delete", + "title": "ApiManagementDeleteWorkspaceProduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceProductApiLink.json new file mode 100644 index 000000000000..9d8a1fa70aef --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceProductApiLink.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceProductApiLink_Delete", + "title": "ApiManagementDeleteWorkspaceProductApiLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceProductGroupLink.json new file mode 100644 index 000000000000..92ce6bec1ccc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceProductGroupLink.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupLinkId": "link1", + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceProductGroupLink_Delete", + "title": "ApiManagementDeleteWorkspaceProductGroupLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceProductPolicy.json new file mode 100644 index 000000000000..4f6251fcaf73 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceProductPolicy.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "policyId": "policy", + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceProductPolicy_Delete", + "title": "ApiManagementDeleteWorkspaceProductPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceSchema.json new file mode 100644 index 000000000000..e6cd6da1acc8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceSchema.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "schemaId": "schema1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceGlobalSchema_Delete", + "title": "ApiManagementDeleteWorkspaceSchema" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceSubscription.json new file mode 100644 index 000000000000..195c1c480443 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceSubscription.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceSubscription_Delete", + "title": "ApiManagementDeleteWorkspaceSubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceTag.json new file mode 100644 index 000000000000..3101f492547d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceTag.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tagId1", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceTag_Delete", + "title": "ApiManagementDeleteWorkspaceTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceTagApiLink.json new file mode 100644 index 000000000000..894c619a3db7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceTagApiLink.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceTagApiLink_Delete", + "title": "ApiManagementDeleteWorkspaceTagApiLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceTagOperationLink.json new file mode 100644 index 000000000000..241d3c9cec8c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceTagOperationLink.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "operationLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceTagOperationLink_Delete", + "title": "ApiManagementDeleteWorkspaceTagOperationLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceTagProductLink.json new file mode 100644 index 000000000000..fd1f0fc2f4c1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeleteWorkspaceTagProductLink.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "WorkspaceTagProductLink_Delete", + "title": "ApiManagementDeleteWorkspaceTagProductLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletedServicesListBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletedServicesListBySubscription.json new file mode 100644 index 000000000000..e45423c5adaf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletedServicesListBySubscription.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "apimService3", + "type": "Microsoft.ApiManagement/deletedservices", + "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3", + "location": "West US", + "properties": { + "deletionDate": "2017-05-27T15:33:55.5426123Z", + "scheduledPurgeDate": "2017-05-27T15:33:55.5426123Z", + "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3" + } + }, + { + "name": "apimService", + "type": "Microsoft.ApiManagement/deletedservices", + "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus2/deletedservices/apimService", + "location": "West US 2", + "properties": { + "deletionDate": "2017-05-27T15:33:55.5426123Z", + "scheduledPurgeDate": "2017-05-27T15:33:55.5426123Z", + "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService" + } + } + ] + } + } + }, + "operationId": "DeletedServices_ListBySubscription", + "title": "ApiManagementDeletedServicesListBySubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletedServicesPurge.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletedServicesPurge.json new file mode 100644 index 000000000000..0b8978505ea7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementDeletedServicesPurge.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "location": "westus", + "serviceName": "apimService3", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "202": { + "body": { + "name": "apimService3", + "type": "Microsoft.ApiManagement/deletedservices", + "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3", + "location": "West US", + "properties": { + "deletionDate": "2017-05-27T15:33:55.5426123Z", + "scheduledPurgeDate": "2017-05-27T15:33:55.5426123Z", + "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3" + } + }, + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2024-10-01-preview" + } + }, + "204": {} + }, + "operationId": "DeletedServices_Purge", + "title": "ApiManagementDeletedServicesPurge" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayDeleteGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayDeleteGateway.json new file mode 100644 index 000000000000..e8eba3e1de4b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayDeleteGateway.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayName": "example-gateway", + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "body": { + "name": "example-gateway", + "type": "Microsoft.ApiManagement/gateway", + "etag": "AAAAAAFfhHY=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateway/example-gateway", + "location": "West US", + "properties": { + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "configurationApi": { + "hostname": "example-gateway.westus.configuration.gateway.azure-api.net" + }, + "createdAtUtc": "2016-12-20T19:41:21.5823069Z", + "frontend": { + "defaultHostname": "example-gateway.westus.gateway.azure-api.net" + }, + "provisioningState": "Succeeded", + "targetProvisioningState": "Deleting" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "tags": {} + }, + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateway/example-gateway/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2024-10-01-preview" + } + }, + "204": {} + }, + "operationId": "ApiGateway_Delete", + "title": "ApiManagementGatewayDeleteGateway" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayGenerateToken.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayGenerateToken.json new file mode 100644 index 000000000000..110ec7b948b5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayGenerateToken.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "parameters": { + "expiry": "2020-04-21T00:44:24.2845269Z", + "keyType": "primary" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg==" + } + } + }, + "operationId": "Gateway_GenerateToken", + "title": "ApiManagementGatewayGenerateToken" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayGetGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayGetGateway.json new file mode 100644 index 000000000000..b6d2825c0b8f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayGetGateway.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayName": "apimService1", + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "example-gateway", + "type": "Microsoft.ApiManagement/gateway", + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateway/example-gateway", + "location": "East US", + "properties": { + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "configurationApi": { + "hostname": "example-gateway.eastus.configuration.gateway.azure-api.net" + }, + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "frontend": { + "defaultHostname": "example-gateway.eastus.gateway.azure-api.net" + }, + "provisioningState": "Succeeded", + "targetProvisioningState": "" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdAt": "2021-06-16T09:40:00.7106733Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "ReleaseName": "Z3", + "owner": "v-aswmoh" + } + } + } + }, + "operationId": "ApiGateway_Get", + "title": "ApiManagementGatewayGetGateway" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayInvalidateDebugCredentials.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayInvalidateDebugCredentials.json new file mode 100644 index 000000000000..6b80b36b409b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayInvalidateDebugCredentials.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + }, + "operationId": "Gateway_InvalidateDebugCredentials", + "title": "ApiManagementGatewayInvalidateDebugCredentials" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayListDebugCredentials.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayListDebugCredentials.json new file mode 100644 index 000000000000..7904278542d2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayListDebugCredentials.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "parameters": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "credentialsExpireAfter": "PT1H", + "purposes": [ + "tracing" + ] + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "token": "p=tracing&aid=a1&ex=20230504000000&sn=ZdfxSJoCsOJE0/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/8LchGl7gu/Q==" + } + } + }, + "operationId": "Gateway_ListDebugCredentials", + "title": "ApiManagementGatewayListDebugCredentials" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayListKeys.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayListKeys.json new file mode 100644 index 000000000000..e4904961a7d3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayListKeys.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "primary": "primary_key_value", + "secondary": "secondary_key_value" + } + } + }, + "operationId": "Gateway_ListKeys", + "title": "ApiManagementGatewayListKeys" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayListTrace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayListTrace.json new file mode 100644 index 000000000000..e981180d9506 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayListTrace.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "parameters": { + "traceId": "CrDvXXXXXXXXXXXXXVU3ZA2-1" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "serviceName": "apimService1", + "traceEntries": { + "inbound": [ + { + "data": { + "request": { + "method": "GET", + "headers": [ + { + "name": "Host", + "value": "proxy.msitesting.net" + } + ], + "url": "https://proxy.msitesting.net/6452XXXXXXXXXXXX9c2facb1/64524dXXXXXXXXXXXX2facb3?subscription-key=117313e70XXXXXXXXXXXX38ba4658ca3" + } + }, + "elapsed": "00:00:00.2983315", + "source": "api-inspector", + "timestamp": "2023-05-03T12:03:04.6899436Z" + }, + { + "data": { + "configuration": { + "api": { + "from": "/6452XXXXXXXXXXXX9c2facb1", + "revision": "1", + "to": { + "path": "/", + "host": "msitesting.net", + "isDefaultPort": true, + "port": 80, + "query": {}, + "queryString": "", + "scheme": "http" + }, + "version": null + }, + "operation": { + "method": "GET", + "uriTemplate": "/64524dXXXXXXXXXXXX2facb3" + }, + "product": "-", + "user": "-" + } + }, + "elapsed": "00:00:00.3046329", + "source": "api-inspector", + "timestamp": "2023-05-03T12:03:04.6969650Z" + }, + { + "data": "Origin header was missing or empty and the request was classified as not cross-domain. CORS policy was not applied.", + "elapsed": "00:00:00.5972352", + "source": "cors", + "timestamp": "2023-05-03T12:03:04.9901631Z" + }, + { + "data": { + "message": [ + "Response status code was set to 200", + "Response status reason was set to 'OK'" + ] + }, + "elapsed": "00:00:00.6107970", + "source": "set-status", + "timestamp": "2023-05-03T12:03:05.0031202Z" + }, + { + "data": { + "message": "Return response was applied", + "response": { + "headers": [], + "status": { + "code": "OK", + "reason": "OK" + } + } + }, + "elapsed": "00:00:00.6164228", + "source": "return-response", + "timestamp": "2023-05-03T12:03:05.0086543Z" + } + ], + "outbound": [ + { + "data": { + "message": "Response has been sent to the caller in full" + }, + "elapsed": "00:00:00.6510195", + "source": "transfer-response", + "timestamp": "2023-05-03T12:03:05.0438287Z" + } + ] + }, + "traceId": "1e0447d4-XXXX-XXXX-XXXX-dbdb8098a0d3" + } + } + }, + "operationId": "Gateway_ListTrace", + "title": "ApiManagementGatewayListTrace" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayRegenerateKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayRegenerateKey.json new file mode 100644 index 000000000000..a2c40b385169 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGatewayRegenerateKey.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "gwId", + "parameters": { + "keyType": "primary" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + }, + "operationId": "Gateway_RegenerateKey", + "title": "ApiManagementGatewayRegenerateKey" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiContract.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiContract.json new file mode 100644 index 000000000000..97d366758e78 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiContract.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", + "properties": { + "type": "soap", + "path": "schulte", + "apiRevision": "1", + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + { + "authorizationServerId": "authorizationServerId2284", + "scope": "oauth2scope2581" + } + ] + }, + "displayName": "Service", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "https" + ], + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + } + } + }, + "operationId": "Api_Get", + "title": "ApiManagementGetApiContract" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiDiagnostic.json new file mode 100644 index 000000000000..c1da6275689c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiDiagnostic.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" + } + } + } + } + }, + "operationId": "ApiDiagnostic_Get", + "title": "ApiManagementGetApiDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiExportInOpenApi2dot0.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiExportInOpenApi2dot0.json new file mode 100644 index 000000000000..947a047cc09a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiExportInOpenApi2dot0.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "format": "swagger-link", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "export": "true", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "format": "swagger-link-json", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", + "value": { + "link": "https://apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore Extensive.json?XXXXXXXX" + } + } + } + }, + "operationId": "ApiExport_Get", + "title": "ApiManagementGetApiExportInOpenApi2dot0" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiExportInOpenApi3dot0.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiExportInOpenApi3dot0.json new file mode 100644 index 000000000000..10cc4757363d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiExportInOpenApi3dot0.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "format": "openapi-link", + "api-version": "2024-10-01-preview", + "apiId": "aid9676", + "export": "true", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "format": "openapi-link", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/aid9676", + "value": { + "link": "https: //apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore.yaml?storage-sas-signatureXXXX" + } + } + } + }, + "operationId": "ApiExport_Get", + "title": "ApiManagementGetApiExportInOpenApi3dot0" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiIssue.json new file mode 100644 index 000000000000..3a6234c47b87 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiIssue.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", + "properties": { + "description": "New API issue description", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "title": "New API issue", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + } + }, + "operationId": "ApiIssue_Get", + "title": "ApiManagementGetApiIssue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiIssueAttachment.json new file mode 100644 index 000000000000..25f3e54f6ae4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiIssueAttachment.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "attachmentId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", + "properties": { + "content": "https://.../image.jpg", + "contentFormat": "link", + "title": "Issue attachment." + } + } + } + }, + "operationId": "ApiIssueAttachment_Get", + "title": "ApiManagementGetApiIssueAttachment" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiIssueComment.json new file mode 100644 index 000000000000..1d5712f24b5d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiIssueComment.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "commentId": "599e29ab193c3c0bd0b3e2fb", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", + "properties": { + "createdDate": "2018-02-01T22:21:20.467Z", + "text": "Issue comment.", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + } + }, + "operationId": "ApiIssueComment_Get", + "title": "ApiManagementGetApiIssueComment" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiOperation.json new file mode 100644 index 000000000000..7cf749f7d8f9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiOperation.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "operationId": "57d2ef278aa04f0ad01d6cdc", + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", + "properties": { + "method": "POST", + "displayName": "CancelOrder", + "templateParameters": [], + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", + "request": { + "description": "IFazioService_CancelOrder_InputMessage", + "headers": [], + "queryParameters": [], + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrder" + } + ] + }, + "responses": [ + { + "description": "IFazioService_CancelOrder_OutputMessage", + "headers": [], + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrderResponse" + } + ], + "statusCode": 200 + } + ] + } + } + } + }, + "operationId": "ApiOperation_Get", + "title": "ApiManagementGetApiOperation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiOperationPetStore.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiOperationPetStore.json new file mode 100644 index 000000000000..a71d1ec77bd3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiOperationPetStore.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "operationId": "loginUser", + "api-version": "2024-10-01-preview", + "apiId": "swagger-petstore", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "loginUser", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/swagger-petstore/operations/loginUser", + "properties": { + "method": "GET", + "description": "", + "displayName": "Logs user into the system", + "templateParameters": [ + { + "name": "username", + "type": "string", + "description": "The user name for login", + "required": true, + "values": [] + }, + { + "name": "password", + "type": "string", + "description": "The password for login in clear text", + "required": true, + "values": [] + } + ], + "urlTemplate": "/user/login?username={username}&password={password}", + "request": { + "headers": [], + "queryParameters": [], + "representations": [] + }, + "responses": [ + { + "description": "successful operation", + "headers": [ + { + "name": "X-Rate-Limit", + "type": "integer", + "description": "calls per hour allowed by the user", + "values": [] + }, + { + "name": "X-Expires-After", + "type": "string", + "description": "date in UTC when token expires", + "values": [] + } + ], + "representations": [ + { + "contentType": "application/xml", + "schemaId": "5ba91a35f373b513a0bf31c6", + "typeName": "UserLoginGet200ApplicationXmlResponse" + }, + { + "contentType": "application/json", + "schemaId": "5ba91a35f373b513a0bf31c6", + "typeName": "UserLoginGet200ApplicationJsonResponse" + } + ], + "statusCode": 200 + }, + { + "description": "Invalid username/password supplied", + "headers": [], + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "statusCode": 400 + } + ] + } + } + } + }, + "operationId": "ApiOperation_Get", + "title": "ApiManagementGetApiOperationPetStore" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiOperationPolicy.json new file mode 100644 index 000000000000..d6ef8f269991 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiOperationPolicy.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "operationId": "5600b53ac53f5b0062080006", + "api-version": "2024-10-01-preview", + "apiId": "5600b539c53f5b0062040001", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/operations/5600b53ac53f5b0062080006/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n This is a sample\r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "ApiOperationPolicy_Get", + "title": "ApiManagementGetApiOperationPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiOperationTag.json new file mode 100644 index 000000000000..82c98dfe9bb3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiOperationTag.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "operationId": "59d6bb8f1f7fab13dc67ec9a", + "api-version": "2024-10-01-preview", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + }, + "operationId": "Tag_GetByOperation", + "title": "ApiManagementGetApiOperationTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiPolicy.json new file mode 100644 index 000000000000..e5995ea87158 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiPolicy.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "5600b59475ff190048040001", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b59475ff190048040001/policies/policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "ApiPolicy_Get", + "title": "ApiManagementGetApiPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiRelease.json new file mode 100644 index 000000000000..d3ecb80b5edc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiRelease.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "a1", + "releaseId": "5a7cb545298324c53224a799", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/5a7cb545298324c53224a799", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "createdDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo", + "updatedDateTime": "2018-02-08T20:38:29.173Z" + } + } + } + }, + "operationId": "ApiRelease_Get", + "title": "ApiManagementGetApiRelease" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiRevision.json new file mode 100644 index 000000000000..14f2f21c5c0b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiRevision.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "echo-api;rev=3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", + "properties": { + "path": "schulte", + "apiRevision": "3", + "apiRevisionDescription": "fixed bug in contract", + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + { + "authorizationServerId": "authorizationServerId2284", + "scope": "oauth2scope2581" + } + ] + }, + "displayName": "Service", + "protocols": [ + "https" + ], + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + } + } + }, + "operationId": "Api_Get", + "title": "ApiManagementGetApiRevisionContract" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiSchema.json new file mode 100644 index 000000000000..718ae7b32a63 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiSchema.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "resourceGroupName": "rg1", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } + }, + "operationId": "ApiSchema_Get", + "title": "ApiManagementGetApiSchema" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiTag.json new file mode 100644 index 000000000000..636e493a619d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiTag.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + }, + "operationId": "Tag_GetByApi", + "title": "ApiManagementGetApiTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiTagDescription.json new file mode 100644 index 000000000000..ed4abb785c44 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiTagDescription.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagDescriptionId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/apis/tagDescriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/tagDescriptions/59306a29e4bbd510dc24e5f9", + "properties": { + "description": null, + "displayName": "tag1", + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com", + "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9" + } + } + } + }, + "operationId": "ApiTagDescription_Get", + "title": "ApiManagementGetApiTagDescription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiVersionSet.json new file mode 100644 index 000000000000..c2f1fae46afa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiVersionSet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "vs1" + }, + "responses": { + "200": { + "body": { + "name": "vs1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1", + "properties": { + "description": "Version configuration", + "displayName": "Version Set 1", + "versioningScheme": "Segment" + } + } + } + }, + "operationId": "ApiVersionSet_Get", + "title": "ApiManagementGetApiVersionSet" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiWiki.json new file mode 100644 index 000000000000..7126baa24fdd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetApiWiki.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + } + }, + "operationId": "ApiWiki_Get", + "title": "ApiManagementGetApiWiki" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorization.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorization.json new file mode 100644 index 000000000000..9be2c398907c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorization.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationId": "authz1", + "authorizationProviderId": "aadwithauthcode", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "AuthorizationCode", + "status": "Connected" + } + } + } + }, + "operationId": "Authorization_Get", + "title": "ApiManagementGetAuthorization" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorizationAccessPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorizationAccessPolicy.json new file mode 100644 index 000000000000..46d4a8cdfe0d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorizationAccessPolicy.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationAccessPolicyId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "authorizationId": "authz1", + "authorizationProviderId": "aadwithauthcode", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies/fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "properties": { + "appIds": [ + "d5f04bb0-ba78-4878-a43e-35a0b74fe315" + ], + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff" + } + } + } + }, + "operationId": "AuthorizationAccessPolicy_Get", + "title": "ApiManagementGetAuthorizationAccessPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorizationLoginRequest.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorizationLoginRequest.json new file mode 100644 index 000000000000..654fb0ba71f6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorizationLoginRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationId": "authz1", + "authorizationProviderId": "aadwithauthcode", + "parameters": { + "postLoginRedirectUrl": "https://www.bing.com/" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "loginLink": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1/login?data=eyJMb2dpbklkIjoiY2YtODNmYzQ5N2YyZWYxNDA4MzlmNDdjZDU3YWY3MmZmODctYW5nYW50aS1wcmV2aWV3X2FhZC1hdXRoY29kZV9vYXV0aDItY29kZV90b2tlbiIsIlNlc3Npb25JZCI6IiIsIkxvZ0Nvbm5lY3Rpb25JZCI6ImF1dGh6MiIsIkxvZ0Nvbm5lY3RvcklkIjoiYWFkLWF1dGhjb2RlIiwiTG9nRW52aXJvbm1lbnRJZCI6ImFuZ2FudGktcHJld" + } + } + }, + "operationId": "AuthorizationLoginLinks_Post", + "title": "ApiManagementGetAuthorizationLoginRequest" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorizationProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorizationProvider.json new file mode 100644 index 000000000000..a37789677c05 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorizationProvider.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationProviderId": "aadwithauthcode", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "aadwithauthcode", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", + "properties": { + "displayName": "aadwithauthcode", + "identityProvider": "aad", + "oauth2": { + "grantTypes": { + "authorizationCode": { + "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d", + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All", + "tenantId": "common" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + } + } + }, + "operationId": "AuthorizationProvider_Get", + "title": "ApiManagementGetAuthorizationProvider" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorizationServer.json new file mode 100644 index 000000000000..bb024a0f8117 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetAuthorizationServer.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authsid": "newauthServer2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "newauthServer2", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer2", + "properties": { + "description": "test server", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientAuthenticationMethod": [ + "Basic" + ], + "clientId": "1", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "defaultScope": "read write", + "displayName": "test3", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "resourceOwnerPassword": "pwd", + "resourceOwnerUsername": "un", + "supportState": true, + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "useInApiDocumentation": true, + "useInTestConsole": false + } + } + } + }, + "operationId": "AuthorizationServer_Get", + "title": "ApiManagementGetAuthorizationServer" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetBackend.json new file mode 100644 index 000000000000..9bd27e7766c7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetBackend.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "backendId": "sfbackend", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "properties": { + "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "managementEndpoints": [ + "https://somecluster.com" + ], + "maxPartitionResolutionRetries": 5, + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ] + } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" + } + } + } + }, + "operationId": "Backend_Get", + "title": "ApiManagementGetBackend" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetCache.json new file mode 100644 index 000000000000..ee929ec16ec6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetCache.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "cacheId": "c1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "c1", + "type": "Microsoft.ApiManagement/service/caches", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", + "properties": { + "description": "Redis cache instances in West India", + "connectionString": "{{5f7fbca77a891a2200f3db38}}", + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1", + "useFromLocation": "default" + } + } + } + }, + "operationId": "Cache_Get", + "title": "ApiManagementGetCache" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetCertificate.json new file mode 100644 index 000000000000..41aa7dfefc21 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetCertificate.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "templateCert1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "templateCert1", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCert1", + "properties": { + "expirationDate": "2017-04-23T17:03:41Z", + "subject": "CN=mutual-authcert", + "thumbprint": "EBA**********************8594A6" + } + } + } + }, + "operationId": "Certificate_Get", + "title": "ApiManagementGetCertificate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetCertificateWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetCertificateWithKeyVault.json new file mode 100644 index 000000000000..08f9eecca138 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetCertificateWithKeyVault.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "templateCertkv", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", + "properties": { + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" + } + } + } + }, + "operationId": "Certificate_Get", + "title": "ApiManagementGetCertificateWithKeyVault" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetClientApplication.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetClientApplication.json new file mode 100644 index 000000000000..c4a9062c12d9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetClientApplication.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "clientApplicationId": "testAppId", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "testAppId", + "type": "Microsoft.ApiManagement/service/clientApplications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId", + "properties": { + "description": "This is just an example application", + "displayName": "Test Application", + "entraApplicationId": "00000000-0000-0000-0000-000000000000", + "entraTenantId": "00000000-0000-0000-0000-000000000000", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId", + "state": "active" + } + } + } + }, + "operationId": "ClientApplication_Get", + "title": "ApiManagementGetClientApplication" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetClientApplicationProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetClientApplicationProductLink.json new file mode 100644 index 000000000000..379672665b44 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetClientApplicationProductLink.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "clientApplicationId": "testAppId", + "clientApplicationProductLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter" + } + } + } + }, + "operationId": "ClientApplicationProductLink_Get", + "title": "ApiManagementGetProductApiLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetContentType.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetContentType.json new file mode 100644 index 000000000000..8ebab1602df2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetContentType.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "contentTypeId": "page", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "page", + "type": "Microsoft.ApiManagement/service/contentTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/contentTypes/page", + "properties": { + "name": "Page", + "schema": { + "additionalProperties": false, + "properties": { + "en_us": { + "type": "object", + "additionalProperties": false, + "properties": { + "description": { + "type": "string", + "description": "Page description. This property gets included in SEO attributes.", + "indexed": true, + "title": "Description" + }, + "documentId": { + "type": "string", + "description": "Reference to page content document.", + "title": "Document ID" + }, + "keywords": { + "type": "string", + "description": "Page keywords. This property gets included in SEO attributes.", + "indexed": true, + "title": "Keywords" + }, + "permalink": { + "type": "string", + "description": "Page permalink, e.g. '/about'.", + "indexed": true, + "title": "Permalink" + }, + "title": { + "type": "string", + "description": "Page title. This property gets included in SEO attributes.", + "indexed": true, + "title": "Title" + } + }, + "required": [ + "title", + "permalink", + "documentId" + ] + } + } + }, + "description": "A regular page", + "version": "1.0.0" + } + } + } + }, + "operationId": "ContentType_Get", + "title": "ApiManagementGetContentType" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetContentTypeContentItem.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetContentTypeContentItem.json new file mode 100644 index 000000000000..506cb91494a6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetContentTypeContentItem.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "contentTypeId": "page", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "properties": { + "en_us": { + "description": "Short story about the company.", + "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "keywords": "company, about", + "permalink": "/about", + "title": "About" + } + } + } + } + }, + "operationId": "ContentItem_Get", + "title": "ApiManagementGetContentTypeContentItem" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetDeletedServiceByName.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetDeletedServiceByName.json new file mode 100644 index 000000000000..dc7057c734a0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetDeletedServiceByName.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "location": "westus", + "serviceName": "apimService3", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService3", + "type": "Microsoft.ApiManagement/deletedservices", + "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3", + "location": "West US", + "properties": { + "deletionDate": "2017-05-27T15:33:55.5426123Z", + "scheduledPurgeDate": "2017-05-27T15:33:55.5426123Z", + "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3" + } + } + } + }, + "operationId": "DeletedServices_GetByName", + "title": "ApiManagementGetDeletedServiceByName" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetDiagnostic.json new file mode 100644 index 000000000000..2a1ab770fbe9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetDiagnostic.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" + } + } + } + } + }, + "operationId": "Diagnostic_Get", + "title": "ApiManagementGetDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetDocumentation.json new file mode 100644 index 000000000000..7d9955ea5395 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetDocumentation.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "documentationId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/documentations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", + "properties": { + "content": "content", + "title": "Title" + } + } + } + }, + "operationId": "Documentation_Get", + "title": "ApiManagementGetDocumentation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGateway.json new file mode 100644 index 000000000000..e08ea9b9ea15 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGateway.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "a1", + "type": "Microsoft.ApiManagement/service/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location" + } + } + } + } + }, + "operationId": "Gateway_Get", + "title": "ApiManagementGetGateway" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGatewayCertificateAuthority.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGatewayCertificateAuthority.json new file mode 100644 index 000000000000..84144bd9249f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGatewayCertificateAuthority.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "cert1", + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "cert1", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", + "properties": { + "isTrusted": true + } + } + } + }, + "operationId": "GatewayCertificateAuthority_Get", + "title": "ApiManagementGetGatewayCertificateAuthority" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGatewayConfigConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGatewayConfigConnection.json new file mode 100644 index 000000000000..946ffeeee182 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGatewayConfigConnection.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "configConnectionName": "gcc-01", + "gatewayName": "standard-gw-01", + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "gcc-1", + "type": "Microsoft.ApiManagement/gateways/configConnections", + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", + "properties": { + "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net", + "provisioningState": "Succeeded", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001" + } + } + } + }, + "operationId": "ApiGatewayConfigConnection_Get", + "title": "ApiManagementGetGatewayConfigConnection" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGatewayHostnameConfiguration.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGatewayHostnameConfiguration.json new file mode 100644 index 000000000000..98166f545b50 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGatewayHostnameConfiguration.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "hcId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", + "properties": { + "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "hostname": "*", + "negotiateClientCertificate": false + } + } + } + }, + "operationId": "GatewayHostnameConfiguration_Get", + "title": "ApiManagementGetGatewayHostnameConfiguration" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGlobalSchema1.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGlobalSchema1.json new file mode 100644 index 000000000000..7d7eae1fdc97 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGlobalSchema1.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "schemaId": "schema1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "GlobalSchema_Get", + "title": "ApiManagementGetSchema1" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGlobalSchema2.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGlobalSchema2.json new file mode 100644 index 000000000000..38b94b5c64b0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGlobalSchema2.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "schemaId": "schema2", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "schema2", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema2", + "properties": { + "description": "sample schema description", + "document": { + "type": "object", + "$id": "https://example.com/person.schema.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "properties": { + "age": { + "type": "integer", + "description": "Age in years which must be equal to or greater than zero.", + "minimum": 0 + }, + "firstName": { + "type": "string", + "description": "The person's first name." + }, + "lastName": { + "type": "string", + "description": "The person's last name." + } + }, + "title": "Person" + }, + "schemaType": "json" + } + } + } + }, + "operationId": "GlobalSchema_Get", + "title": "ApiManagementGetSchema2" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGraphQLApiResolver.json new file mode 100644 index 000000000000..c418eaaffb58 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGraphQLApiResolver.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resolverId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc", + "properties": { + "path": "Query/users", + "description": "A GraphQL Resolver example", + "displayName": "Query Users" + } + } + } + }, + "operationId": "GraphQLApiResolver_Get", + "title": "ApiManagementGetGraphQLApiResolver" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGraphQLApiResolverPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGraphQLApiResolverPolicy.json new file mode 100644 index 000000000000..54f490aaed44 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGraphQLApiResolverPolicy.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "5600b539c53f5b0062040001", + "policyId": "policy", + "resolverId": "5600b53ac53f5b0062080006", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/resolvers/5600b53ac53f5b0062080006/policies/policy", + "properties": { + "value": "\r\n \r\n GET\r\n\r\n/api/users\r\n\r\n" + } + } + } + }, + "operationId": "GraphQLApiResolverPolicy_Get", + "title": "ApiManagementGetGraphQLApiResolverPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGroup.json new file mode 100644 index 000000000000..c8c49ffedb0e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetGroup.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "59306a29e4bbd510dc24e5f9", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9", + "properties": { + "type": "external", + "description": "awesome group of people", + "builtIn": false, + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + } + } + }, + "operationId": "Group_Get", + "title": "ApiManagementGetGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetIdentityProvider.json new file mode 100644 index 000000000000..fc5a6865748c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetIdentityProvider.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "identityProviderName": "aadB2C", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "AadB2C", + "type": "Microsoft.ApiManagement/service/identityProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C", + "properties": { + "type": "aadB2C", + "allowedTenants": [ + "contosoaadb2c.onmicrosoft.com", + "contoso2aadb2c.onmicrosoft.com" + ], + "authority": "login.microsoftonline.com", + "clientId": "f02dafe2-b8b8-48ec-a38e-27e5c16c51e5", + "signinPolicyName": "B2C_1_policy-signin", + "signinTenant": "contosoaadb2c.onmicrosoft.com", + "signupPolicyName": "B2C_1_policy-signup" + } + } + } + }, + "operationId": "IdentityProvider_Get", + "title": "ApiManagementGetIdentityProvider" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetIssue.json new file mode 100644 index 000000000000..bfbdada4e856 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetIssue.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/issues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues/57d2ef278aa04f0ad01d6cdc", + "properties": { + "description": "New API issue description", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "title": "New API issue", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + } + }, + "operationId": "Issue_Get", + "title": "ApiManagementGetIssue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetLogger.json new file mode 100644 index 000000000000..1cf3bd1c982f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetLogger.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "loggerId": "templateLogger", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "kloudapilogger1", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/kloudapilogger1", + "properties": { + "description": "testeventhub3again", + "credentials": { + "name": "testeventhub4", + "connectionString": "Endpoint=sb://eventhubapim.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=************" + }, + "isBuffered": true, + "loggerType": "azureEventHub", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/eventhubapim" + } + } + } + }, + "operationId": "Logger_Get", + "title": "ApiManagementGetLogger" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetNamedValue.json new file mode 100644 index 000000000000..508c86f9eb53 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetNamedValue.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "namedValueId": "testarmTemplateproperties2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "testarmTemplateproperties2", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testarmTemplateproperties2", + "properties": { + "displayName": "propName", + "secret": false, + "tags": [ + "foo", + "bar" + ], + "value": "propValue" + } + } + } + }, + "operationId": "NamedValue_Get", + "title": "ApiManagementGetNamedValue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetNamedValueWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetNamedValueWithKeyVault.json new file mode 100644 index 000000000000..49faac881824 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetNamedValueWithKeyVault.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "namedValueId": "testprop6", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "secret": true, + "tags": [ + "foo", + "bar" + ] + } + } + } + }, + "operationId": "NamedValue_Get", + "title": "ApiManagementGetNamedValueWithKeyVault" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetNotification.json new file mode 100644 index 000000000000..8b4c4633357a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetNotification.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", + "properties": { + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/contoso@live.com", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar!live", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + }, + "title": "Subscription requests (requiring approval)" + } + } + } + }, + "operationId": "Notification_Get", + "title": "ApiManagementGetNotification" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetOpenIdConnectProvider.json new file mode 100644 index 000000000000..86d5df11821a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetOpenIdConnectProvider.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "opid": "templateOpenIdConnect2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "templateOpenIdConnect2", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", + "properties": { + "description": "open id provider template2", + "clientId": "oidprovidertemplate2", + "displayName": "templateoidprovider2", + "metadataEndpoint": "https://oidprovider-template2.net", + "useInApiDocumentation": true, + "useInTestConsole": false + } + } + } + }, + "operationId": "OpenIdConnectProvider_Get", + "title": "ApiManagementGetOpenIdConnectProvider" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetOperationResult.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetOperationResult.json new file mode 100644 index 000000000000..2604e31609d9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetOperationResult.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "operationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "api-version": "2024-10-01-preview", + "location": "westus2", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ApiManagement/locations/westus2/operationResults/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx?api-version=2024-10-01-preview" + } + } + }, + "operationId": "OperationsResults_Get", + "title": "ApiManagementGetOperationResult" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetOperationStatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetOperationStatus.json new file mode 100644 index 000000000000..a3acd59e3c33 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetOperationStatus.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "operationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "api-version": "2024-10-01-preview", + "location": "testLocation", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "status": "InProgress" + } + } + }, + "operationId": "OperationStatus_Get", + "title": "Get operation status" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicy.json new file mode 100644 index 000000000000..915ed286b10d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicy.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "Policy_Get", + "title": "ApiManagementGetPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicyFormat.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicyFormat.json new file mode 100644 index 000000000000..7ee42c0b4d5b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicyFormat.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "format": "rawxml", + "api-version": "2024-10-01-preview", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "properties": { + "format": "rawxml", + "value": "\r\n\r\n\t\r\n\t\t\r\n\t\t\t@{\n var guidBinary = new byte[16];\n Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10);\n long time = DateTime.Now.Ticks;\n byte[] bytes = new byte[6];\n unchecked\n {\n bytes[5] = (byte)(time >> 40);\n bytes[4] = (byte)(time >> 32);\n bytes[3] = (byte)(time >> 24);\n bytes[2] = (byte)(time >> 16);\n bytes[1] = (byte)(time >> 8);\n bytes[0] = (byte)(time);\n }\n Array.Copy(bytes, 0, guidBinary, 10, 6);\n return new Guid(guidBinary).ToString();\n }\n \r\n\t\t\r\n\t\r\n\t\r\n\t\t\r\n\t\r\n\t\r\n\t\r\n" + } + } + } + }, + "operationId": "Policy_Get", + "title": "ApiManagementGetPolicyFormat" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicyFragment.json new file mode 100644 index 000000000000..3eaceed33490 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicyFragment.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "" + } + } + } + }, + "operationId": "PolicyFragment_Get", + "title": "ApiManagementGetPolicyFragment" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicyFragmentFormat.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicyFragmentFormat.json new file mode 100644 index 000000000000..0c6a6928e8c9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicyFragmentFormat.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "format": "rawxml", + "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", + "properties": { + "format": "rawxml", + "description": "A policy fragment example", + "value": "\r\n\t\t\t@{\n var guidBinary = new byte[16];\n Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10);\n long time = DateTime.Now.Ticks;\n byte[] bytes = new byte[6];\n unchecked\n {\n bytes[5] = (byte)(time >> 40);\n bytes[4] = (byte)(time >> 32);\n bytes[3] = (byte)(time >> 24);\n bytes[2] = (byte)(time >> 16);\n bytes[1] = (byte)(time >> 8);\n bytes[0] = (byte)(time);\n }\n Array.Copy(bytes, 0, guidBinary, 10, 6);\n return new Guid(guidBinary).ToString();\n }\n \r\n\t\t" + } + } + } + }, + "operationId": "PolicyFragment_Get", + "title": "ApiManagementGetPolicyFragmentFormat" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicyRestriction.json new file mode 100644 index 000000000000..90d4522e8a4a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPolicyRestriction.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "policyRestrictionId": "policyRestriction1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policyRestriction1", + "type": "Microsoft.ApiManagement/service/policyRestrictions", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", + "properties": { + "requireBase": "true", + "scope": "Sample Path to the policy document." + } + } + } + }, + "operationId": "PolicyRestriction_Get", + "title": "ApiManagementGetPolicyRestriction" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPortalRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPortalRevision.json new file mode 100644 index 000000000000..63f4ae63f167 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPortalRevision.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "portalRevisionId": "20201112101010", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "20201112101010", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010", + "properties": { + "description": "portal revision 1", + "createdDateTime": "2020-11-12T22:51:36.47Z", + "isCurrent": true, + "status": "completed", + "statusDetails": null, + "updatedDateTime": "2020-11-12T22:52:00.097Z" + } + } + } + }, + "operationId": "PortalRevision_Get", + "title": "ApiManagementGetPortalRevision" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPrivateEndpointConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..c5edc12ea05d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPrivateEndpointConnection.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "privateEndpointProxyName", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "description": "Please approve my request, thanks", + "actionsRequired": "None", + "status": "Pending" + }, + "provisioningState": "Pending" + } + } + } + }, + "operationId": "PrivateEndpointConnection_GetByName", + "title": "ApiManagementGetPrivateEndpointConnection" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPrivateLinkGroupResource.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPrivateLinkGroupResource.json new file mode 100644 index 000000000000..80885732818b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetPrivateLinkGroupResource.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "privateLinkSubResourceName": "privateLinkSubResourceName", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "Gateway", + "type": "Microsoft.ApiManagement/service/privateLinkResources", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/Gateway", + "properties": { + "groupId": "Gateway", + "requiredMembers": [ + "Gateway" + ], + "requiredZoneNames": [ + "privateLink.azure-api.net" + ] + } + } + } + }, + "operationId": "PrivateEndpointConnection_GetPrivateLinkResource", + "title": "ApiManagementGetPrivateLinkGroupResource" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProduct.json new file mode 100644 index 000000000000..b0dc9ad1003f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProduct.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "unlimited", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "unlimited", + "type": "Microsoft.ApiManagement/service/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited", + "properties": { + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "approvalRequired": true, + "displayName": "Unlimited", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1 + } + } + } + }, + "operationId": "Product_Get", + "title": "ApiManagementGetProduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductApiLink.json new file mode 100644 index 000000000000..05303b6d22a1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductApiLink.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + } + }, + "operationId": "ProductApiLink_Get", + "title": "ApiManagementGetProductApiLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductGroupLink.json new file mode 100644 index 000000000000..49e280fd833d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductGroupLink.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupLinkId": "link1", + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/products/groupLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groupLinks/link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" + } + } + } + }, + "operationId": "ProductGroupLink_Get", + "title": "ApiManagementGetProductGroupLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductPolicy.json new file mode 100644 index 000000000000..f11cda581d06 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductPolicy.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "policyId": "policy", + "productId": "kjoshiarmTemplateProduct4", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmTemplateProduct4/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "ProductPolicy_Get", + "title": "ApiManagementGetProductPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductTag.json new file mode 100644 index 000000000000..67f660fb28bc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductTag.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "59d6bb8f1f7fab13dc67ec9b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + }, + "operationId": "Tag_GetByProduct", + "title": "ApiManagementGetProductTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductWiki.json new file mode 100644 index 000000000000..86482bcf1f4c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetProductWiki.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + } + }, + "operationId": "ProductWiki_Get", + "title": "ApiManagementGetProductWiki" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetQuotaCounterKeys.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetQuotaCounterKeys.json new file mode 100644 index 000000000000..85eb76ac2b4c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetQuotaCounterKeys.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "quotaCounterKey": "ba", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "counterKey": "ba", + "periodEndTime": "2018-02-08T16:54:40Z", + "periodKey": "0_P3Y6M4DT12H30M5S", + "periodStartTime": "2014-08-04T04:24:35Z", + "value": { + "callsCount": 5, + "kbTransferred": 2.5830078125 + } + } + ] + } + } + }, + "operationId": "QuotaByCounterKeys_ListByService", + "title": "ApiManagementGetQuotaCounterKeys" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json new file mode 100644 index 000000000000..2ef704a06c37 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "quotaCounterKey": "ba", + "quotaPeriodKey": "0_P3Y6M4DT12H30M5S", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "counterKey": "ba", + "periodEndTime": "2018-02-08T16:54:40Z", + "periodKey": "0_P3Y6M4DT12H30M5S", + "periodStartTime": "2014-08-04T04:24:35Z", + "value": { + "callsCount": 0, + "kbTransferred": 2.5625 + } + } + } + }, + "operationId": "QuotaByPeriodKeys_Get", + "title": "ApiManagementGetQuotaCounterKeysByQuotaPeriod" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByApi.json new file mode 100644 index 000000000000..7ec95bfcb564 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByApi.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "Echo API", + "apiId": "/apis/5600b59475ff190048040001", + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 0, + "callCountTotal": 0, + "serviceTimeAvg": 0, + "serviceTimeMax": 0, + "serviceTimeMin": 0 + }, + { + "name": "httpbin", + "apiId": "/apis/57a03a13e4bbd5119c8b19e9", + "apiTimeAvg": 1015.7607923076923, + "apiTimeMax": 1819.2173, + "apiTimeMin": 330.3206, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 13, + "callCountTotal": 14, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMax": 1697.3612, + "serviceTimeMin": 215.24 + } + ] + } + } + }, + "operationId": "Reports_ListByApi", + "title": "ApiManagementGetReportsByApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByGeo.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByGeo.json new file mode 100644 index 000000000000..fe6abb3629a4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByGeo.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "apiTimeAvg": 1015.7607923076923, + "apiTimeMax": 1819.2173, + "apiTimeMin": 330.3206, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 13, + "callCountTotal": 14, + "country": "US", + "region": "WA", + "serviceTimeAvg": 957.094776923077, + "serviceTimeMax": 1697.3612, + "serviceTimeMin": 215.24, + "zip": "98052" + } + ] + } + } + }, + "operationId": "Reports_ListByGeo", + "title": "ApiManagementGetReportsByGeo" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByOperation.json new file mode 100644 index 000000000000..28feef4d1cd3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByOperation.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "get", + "operationId": "/apis/57a03a13e4bbd5119c8b19e9/operations/57a03a1dd8d14f0a780d7d14", + "apiId": "/apis/57a03a13e4bbd5119c8b19e9", + "apiTimeAvg": 1015.7607923076923, + "apiTimeMax": 1819.2173, + "apiTimeMin": 330.3206, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 13, + "callCountTotal": 14, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMax": 1697.3612, + "serviceTimeMin": 215.24 + }, + { + "name": "GetWeatherInformation", + "operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93e", + "apiId": "/apis/57c999d1e4bbd50c988cb2c3", + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 0, + "callCountTotal": 0, + "serviceTimeAvg": 0, + "serviceTimeMax": 0, + "serviceTimeMin": 0 + }, + { + "name": "GetCityForecastByZIP", + "operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93f", + "apiId": "/apis/57c999d1e4bbd50c988cb2c3", + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 0, + "callCountTotal": 0, + "serviceTimeAvg": 0, + "serviceTimeMax": 0, + "serviceTimeMin": 0 + } + ] + } + } + }, + "operationId": "Reports_ListByOperation", + "title": "ApiManagementGetReportsByOperation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByProduct.json new file mode 100644 index 000000000000..de3af4f4a9a0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByProduct.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "Starter", + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 0, + "callCountTotal": 0, + "productId": "/products/5600b59475ff190048060001", + "serviceTimeAvg": 0, + "serviceTimeMax": 0, + "serviceTimeMin": 0 + }, + { + "name": "Unlimited", + "apiTimeAvg": 1015.7607923076923, + "apiTimeMax": 1819.2173, + "apiTimeMin": 330.3206, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 13, + "callCountTotal": 14, + "productId": "/products/5600b59475ff190048060002", + "serviceTimeAvg": 957.094776923077, + "serviceTimeMax": 1697.3612, + "serviceTimeMin": 215.24 + } + ] + } + } + }, + "operationId": "Reports_ListByProduct", + "title": "ApiManagementGetReportsByProduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByRequest.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByRequest.json new file mode 100644 index 000000000000..a2094623f348 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByRequest.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 2, + "value": [ + { + "operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-", + "method": "GET", + "apiId": "/apis/5931a75ae4bbd512a88c680b", + "apiRegion": "East Asia", + "apiTime": 221.1544, + "cache": "none", + "ipAddress": "207.xx.155.xx", + "productId": "/products/-", + "requestId": "63e7119c-26aa-433c-96d7-f6f3267ff52f", + "requestSize": 0, + "responseCode": 404, + "responseSize": 405, + "serviceTime": 0, + "subscriptionId": "/subscriptions/5600b59475ff190048070002", + "timestamp": "2017-06-03T00:17:00.1649134Z", + "url": "https://apimService1.azure-api.net/echo/resource?param1=sample", + "userId": "/users/1" + }, + { + "operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-", + "method": "POST", + "apiId": "/apis/5931a75ae4bbd512a88c680b", + "apiRegion": "East Asia", + "apiTime": 6.675400000000001, + "cache": "none", + "ipAddress": "207.xx.155.xx", + "productId": "/products/-", + "requestId": "e581b7f7-c9ec-4fc6-8ab9-3855d9b00b04", + "requestSize": 0, + "responseCode": 404, + "responseSize": 403, + "serviceTime": 0, + "subscriptionId": "/subscriptions/5600b59475ff190048070002", + "timestamp": "2017-06-03T00:17:20.5255131Z", + "url": "https://apimService1.azure-api.net/echo/resource", + "userId": "/users/1" + } + ] + } + } + }, + "operationId": "Reports_ListByRequest", + "title": "ApiManagementGetReportsByRequest" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsBySubscription.json new file mode 100644 index 000000000000..e15d3165d751 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsBySubscription.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "", + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 0, + "callCountTotal": 0, + "productId": "/products/5600b59475ff190048060001", + "serviceTimeAvg": 0, + "serviceTimeMax": 0, + "serviceTimeMin": 0, + "subscriptionId": "/subscriptions/5600b59475ff190048070001", + "userId": "/users/1" + }, + { + "name": "", + "apiTimeAvg": 1015.7607923076923, + "apiTimeMax": 1819.2173, + "apiTimeMin": 330.3206, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 13, + "callCountTotal": 14, + "productId": "/products/5600b59475ff190048060002", + "serviceTimeAvg": 957.094776923077, + "serviceTimeMax": 1697.3612, + "serviceTimeMin": 215.24, + "subscriptionId": "/subscriptions/5600b59475ff190048070002", + "userId": "/users/1" + }, + { + "name": "", + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 0, + "callCountTotal": 0, + "productId": "/products/5702e97e5157a50f48dce801", + "serviceTimeAvg": 0, + "serviceTimeMax": 0, + "serviceTimeMin": 0, + "subscriptionId": "/subscriptions/5702e97e5157a50a9c733303", + "userId": "/users/1" + } + ] + } + } + }, + "operationId": "Reports_ListBySubscription", + "title": "ApiManagementGetReportsBySubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByTime.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByTime.json new file mode 100644 index 000000000000..473969705f96 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByTime.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", + "api-version": "2024-10-01-preview", + "interval": "PT15M", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "apiTimeAvg": 1337.46335, + "apiTimeMax": 1819.2173, + "apiTimeMin": 885.0839000000001, + "bandwidth": 3243, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 4, + "callCountTotal": 4, + "interval": "PT15M", + "serviceTimeAvg": 1255.917425, + "serviceTimeMax": 1697.3612, + "serviceTimeMin": 882.8264, + "timestamp": "2017-06-03T00:15:00Z" + }, + { + "apiTimeAvg": 872.7818777777778, + "apiTimeMax": 1093.8407, + "apiTimeMin": 330.3206, + "bandwidth": 7776, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 9, + "callCountTotal": 10, + "interval": "PT15M", + "serviceTimeAvg": 824.2847111111112, + "serviceTimeMax": 973.2262000000001, + "serviceTimeMin": 215.24, + "timestamp": "2017-06-03T00:30:00Z" + } + ] + } + } + }, + "operationId": "Reports_ListByTime", + "title": "ApiManagementGetReportsByTime" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByUser.json new file mode 100644 index 000000000000..0a20768c2fd3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetReportsByUser.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "Administrator", + "apiTimeAvg": 1015.7607923076923, + "apiTimeMax": 1819.2173, + "apiTimeMin": 330.3206, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 13, + "callCountTotal": 14, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMax": 1697.3612, + "serviceTimeMin": 215.24, + "userId": "/users/1" + }, + { + "name": "Samir Solanki", + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 0, + "callCountTotal": 0, + "serviceTimeAvg": 0, + "serviceTimeMax": 0, + "serviceTimeMin": 0, + "userId": "/users/56eaec62baf08b06e46d27fd" + }, + { + "name": "Anonymous", + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountSuccess": 0, + "callCountTotal": 0, + "serviceTimeAvg": 0, + "serviceTimeMax": 0, + "serviceTimeMin": 0, + "userId": "/users/54c800b332965a0035030000" + } + ] + } + } + }, + "operationId": "Reports_ListByUser", + "title": "ApiManagementGetReportsByUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetSubscription.json new file mode 100644 index 000000000000..8916cb5f4741 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetSubscription.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "5931a769d8d14f0ad8ce13b8", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8", + "properties": { + "createdDate": "2017-06-02T17:59:06.223Z", + "displayName": "Unlimited", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "state": "submitted" + } + } + } + }, + "operationId": "Subscription_Get", + "title": "ApiManagementGetSubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTag.json new file mode 100644 index 000000000000..862f52a34927 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTag.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + }, + "operationId": "Tag_Get", + "title": "ApiManagementGetTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTagApiLink.json new file mode 100644 index 000000000000..363f8a1e6525 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTagApiLink.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + } + }, + "operationId": "TagApiLink_Get", + "title": "ApiManagementGetTagApiLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTagOperationLink.json new file mode 100644 index 000000000000..852593a39cee --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTagOperationLink.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "operationLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" + } + } + } + }, + "operationId": "TagOperationLink_Get", + "title": "ApiManagementGetTagOperationLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTagProductLink.json new file mode 100644 index 000000000000..b8498b6cd75f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTagProductLink.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" + } + } + } + }, + "operationId": "TagProductLink_Get", + "title": "ApiManagementGetTagProductLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTemplate.json new file mode 100644 index 000000000000..c6bb836b9ab3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTemplate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "templateName": "newIssueNotificationMessage" + }, + "responses": { + "200": { + "body": { + "name": "NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", + "properties": { + "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "isDefault": true, + "parameters": [ + { + "name": "DevFirstName", + "title": "Developer first name" + }, + { + "name": "DevLastName", + "title": "Developer last name" + }, + { + "name": "IssueId", + "title": "Issue id" + }, + { + "name": "IssueName", + "title": "Issue name" + }, + { + "name": "OrganizationName", + "title": "Organization name" + }, + { + "name": "DevPortalUrl", + "title": "Developer portal URL" + } + ], + "subject": "Your request $IssueName was received", + "title": "New issue received" + } + } + } + }, + "operationId": "EmailTemplate_Get", + "title": "ApiManagementGetTemplate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTenantAccess.json new file mode 100644 index 000000000000..d17ffa05e647 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTenantAccess.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "accessName": "access", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "access", + "type": "Microsoft.ApiManagement/service/tenant", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", + "properties": { + "enabled": true + } + } + } + }, + "operationId": "TenantAccess_Get", + "title": "ApiManagementGetTenantAccess" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTenantGitAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTenantGitAccess.json new file mode 100644 index 000000000000..31e29a74f04f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTenantGitAccess.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "accessName": "gitAccess", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "gitAccess", + "type": "Microsoft.ApiManagement/service/tenant", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/gitAccess", + "properties": { + "enabled": true, + "principalId": "git" + } + } + } + }, + "operationId": "TenantAccess_Get", + "title": "ApiManagementGetTenantGitAccess" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTenantSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTenantSettings.json new file mode 100644 index 000000000000..ea8383bf2b7c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetTenantSettings.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "settingsType": "public", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "public", + "type": "Microsoft.ApiManagement/service/settings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/settings/public", + "properties": { + "settings": { + "CustomPortalSettings.DelegatedSubscriptionEnabled": "False", + "CustomPortalSettings.DelegationEnabled": "False", + "CustomPortalSettings.DelegationUrl": "", + "CustomPortalSettings.UserRegistrationTerms": null, + "CustomPortalSettings.UserRegistrationTermsConsentRequired": "False", + "CustomPortalSettings.UserRegistrationTermsEnabled": "False" + } + } + } + } + }, + "operationId": "TenantSettings_Get", + "title": "ApiManagementGetTenantSettings" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetUser.json new file mode 100644 index 000000000000..2dfb834c80fd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetUser.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512a88c680b" + }, + "responses": { + "200": { + "body": { + "name": "5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "properties": { + "email": "foobar@outlook.com", + "firstName": "foo", + "identities": [ + { + "id": "*************", + "provider": "Microsoft" + } + ], + "lastName": "bar", + "registrationDate": "2017-06-02T17:58:50.357Z", + "state": "active" + } + } + } + }, + "operationId": "User_Get", + "title": "ApiManagementGetUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetUserSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetUserSubscription.json new file mode 100644 index 000000000000..1aeef14395cd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetUserSubscription.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "5fa9b096f3df14003c070001", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "1" + }, + "responses": { + "200": { + "body": { + "name": "5fa9b096f3df14003c070001", + "type": "Microsoft.ApiManagement/service/users/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1/subscriptions/5fa9b096f3df14003c070001", + "properties": { + "allowTracing": true, + "createdDate": "2020-11-09T21:11:50.58Z", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter", + "state": "active" + } + } + } + }, + "operationId": "UserSubscription_Get", + "title": "ApiManagementGetUserSubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspace.json new file mode 100644 index 000000000000..7c518c715d87 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspace.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", + "properties": { + "description": "workspace 1", + "displayName": "my workspace" + } + } + } + }, + "operationId": "Workspace_Get", + "title": "ApiManagementGetWorkspace" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiContract.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiContract.json new file mode 100644 index 000000000000..12b1bfcc032c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiContract.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d1f7558aa04f15146d9d8a", + "properties": { + "type": "soap", + "path": "schulte", + "apiRevision": "1", + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + { + "authorizationServerId": "authorizationServerId2284", + "scope": "oauth2scope2581" + } + ] + }, + "displayName": "Service", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "https" + ], + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + } + } + }, + "operationId": "WorkspaceApi_Get", + "title": "ApiManagementGetWorkspaceApiContract" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiDiagnostic.json new file mode 100644 index 000000000000..b83a1b7e4248 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiDiagnostic.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" + } + } + } + } + }, + "operationId": "WorkspaceApiDiagnostic_Get", + "title": "ApiManagementGetWorkspaceApiDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiExportInOpenApi2dot0.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiExportInOpenApi2dot0.json new file mode 100644 index 000000000000..577193210c2e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiExportInOpenApi2dot0.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "format": "swagger-link", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "export": "true", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "format": "swagger-link-json", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api", + "value": { + "link": "https://apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore Extensive.json?storage-sas-signature" + } + } + } + }, + "operationId": "WorkspaceApiExport_Get", + "title": "ApiManagementGetWorkspaceApiExportInOpenApi2dot0" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiExportInOpenApi3dot0.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiExportInOpenApi3dot0.json new file mode 100644 index 000000000000..ec99e5b31994 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiExportInOpenApi3dot0.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "format": "openapi-link", + "api-version": "2024-10-01-preview", + "apiId": "aid9676", + "export": "true", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "format": "openapi-link", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/aid9676", + "value": { + "link": "https: //apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore.yaml?storage-sas-signature" + } + } + } + }, + "operationId": "WorkspaceApiExport_Get", + "title": "ApiManagementGetWorkspaceApiExportInOpenApi3dot0" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiOperation.json new file mode 100644 index 000000000000..8b3f1a5a5884 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiOperation.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "operationId": "57d2ef278aa04f0ad01d6cdc", + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", + "properties": { + "method": "POST", + "displayName": "CancelOrder", + "templateParameters": [], + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", + "request": { + "description": "IFazioService_CancelOrder_InputMessage", + "headers": [], + "queryParameters": [], + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrder" + } + ] + }, + "responses": [ + { + "description": "IFazioService_CancelOrder_OutputMessage", + "headers": [], + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrderResponse" + } + ], + "statusCode": 200 + } + ] + } + } + } + }, + "operationId": "WorkspaceApiOperation_Get", + "title": "ApiManagementGetWorkspaceApiOperation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiOperationPolicy.json new file mode 100644 index 000000000000..73fc598fef24 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiOperationPolicy.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "operationId": "5600b53ac53f5b0062080006", + "api-version": "2024-10-01-preview", + "apiId": "5600b539c53f5b0062040001", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b539c53f5b0062040001/operations/5600b53ac53f5b0062080006/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n This is a sample\r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "WorkspaceApiOperationPolicy_Get", + "title": "ApiManagementGetWorkspaceApiOperationPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiPolicy.json new file mode 100644 index 000000000000..d722cab6cbdb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiPolicy.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "5600b59475ff190048040001", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b59475ff190048040001/policies/policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "WorkspaceApiPolicy_Get", + "title": "ApiManagementGetWorkspaceApiPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiRelease.json new file mode 100644 index 000000000000..07647d1170a0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiRelease.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "a1", + "releaseId": "5a7cb545298324c53224a799", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/5a7cb545298324c53224a799", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", + "createdDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo", + "updatedDateTime": "2018-02-08T20:38:29.173Z" + } + } + } + }, + "operationId": "WorkspaceApiRelease_Get", + "title": "ApiManagementGetWorkspaceApiRelease" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiRevision.json new file mode 100644 index 000000000000..6cae1cd865a1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiRevision.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "echo-api;rev=3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api;rev=3", + "properties": { + "path": "schulte", + "apiRevision": "3", + "apiRevisionDescription": "fixed bug in contract", + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + "oAuth2AuthenticationSettings": [ + { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + }, + { + "authorizationServerId": "authorizationServerId2284", + "scope": "oauth2scope2581" + } + ] + }, + "displayName": "Service", + "protocols": [ + "https" + ], + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + } + } + }, + "operationId": "WorkspaceApi_Get", + "title": "ApiManagementGetWorkspaceApiRevision" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiSchema.json new file mode 100644 index 000000000000..a8b91130e67d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiSchema.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "resourceGroupName": "rg1", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } + }, + "operationId": "WorkspaceApiSchema_Get", + "title": "ApiManagementGetWorkspaceApiSchema" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiVersionSet.json new file mode 100644 index 000000000000..7977880fdbf5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceApiVersionSet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "vs1", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "vs1", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs1", + "properties": { + "description": "Version configuration", + "displayName": "Version Set 1", + "versioningScheme": "Segment" + } + } + } + }, + "operationId": "WorkspaceApiVersionSet_Get", + "title": "ApiManagementGetWorkspaceApiVersionSet" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceBackend.json new file mode 100644 index 000000000000..15c0ed55cf58 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceBackend.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "backendId": "sfbackend", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "properties": { + "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "managementEndpoints": [ + "https://somecluster.com" + ], + "maxPartitionResolutionRetries": 5, + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ] + } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" + } + } + } + }, + "operationId": "WorkspaceBackend_Get", + "title": "ApiManagementGetWorkspaceBackend" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceCertificate.json new file mode 100644 index 000000000000..46d113c1c75a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceCertificate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "templateCert1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "templateCert1", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCert1", + "properties": { + "expirationDate": "2017-04-23T17:03:41Z", + "subject": "CN=mutual-authcert", + "thumbprint": "EBA**********************8594A6" + } + } + } + }, + "operationId": "WorkspaceCertificate_Get", + "title": "ApiManagementGetWorkspaceCertificate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceCertificateWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceCertificateWithKeyVault.json new file mode 100644 index 000000000000..d2f2aef75f81 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceCertificateWithKeyVault.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "templateCertkv", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", + "properties": { + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" + } + } + } + }, + "operationId": "WorkspaceCertificate_Get", + "title": "ApiManagementGetWorkspaceCertificateWithKeyVault" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceDiagnostic.json new file mode 100644 index 000000000000..414cde9acd77 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceDiagnostic.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" + } + } + } + } + }, + "operationId": "WorkspaceDiagnostic_Get", + "title": "ApiManagementGetWorkspaceDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceGroup.json new file mode 100644 index 000000000000..afdf753f6088 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceGroup.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "59306a29e4bbd510dc24e5f9", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/59306a29e4bbd510dc24e5f9", + "properties": { + "type": "external", + "description": "awesome group of people", + "builtIn": false, + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + } + } + }, + "operationId": "WorkspaceGroup_Get", + "title": "ApiManagementGetWorkspaceGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceLink.json new file mode 100644 index 000000000000..9a4e1bf2675b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceLink.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "service1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wk-1" + }, + "responses": { + "200": { + "body": { + "name": "wk-1", + "type": "Microsoft.ApiManagement/service/workspaceLinks", + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/service-1/workspaceLinks/wk-1", + "properties": { + "gateways": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/gateway-1" + } + ], + "workspaceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/service-1/workspaces/wk-1" + } + } + } + }, + "operationId": "ApiManagementWorkspaceLink_Get", + "title": "ApiManagementGetWorkspaceLinks" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceLogger.json new file mode 100644 index 000000000000..b63d9674e04c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceLogger.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "loggerId": "templateLogger", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "kloudapilogger1", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/kloudapilogger1", + "properties": { + "description": "testeventhub3again", + "credentials": { + "name": "testeventhub4", + "connectionString": "Endpoint=sb://eventhubapim.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=************" + }, + "isBuffered": true, + "loggerType": "azureEventHub", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/eventhubapim" + } + } + } + }, + "operationId": "WorkspaceLogger_Get", + "title": "ApiManagementGetWorkspaceLogger" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceNamedValue.json new file mode 100644 index 000000000000..83e718316f96 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceNamedValue.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "namedValueId": "testarmTemplateproperties2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "testarmTemplateproperties2", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testarmTemplateproperties2", + "properties": { + "displayName": "propName", + "secret": false, + "tags": [ + "foo", + "bar" + ], + "value": "propValue" + } + } + } + }, + "operationId": "WorkspaceNamedValue_Get", + "title": "ApiManagementGetWorkspaceNamedValue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceNamedValueWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceNamedValueWithKeyVault.json new file mode 100644 index 000000000000..a82e4cb5bf7b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceNamedValueWithKeyVault.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "namedValueId": "testprop6", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "testprop6", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testarmTemplateproperties2", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "secret": true, + "tags": [ + "foo", + "bar" + ] + } + } + } + }, + "operationId": "WorkspaceNamedValue_Get", + "title": "ApiManagementGetWorkspaceNamedValueWithKeyVault" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceNotification.json new file mode 100644 index 000000000000..3a2b10d86c68 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceNotification.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/workspaces/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage", + "properties": { + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + }, + "title": "Subscription requests (requiring approval)" + } + } + } + }, + "operationId": "WorkspaceNotification_Get", + "title": "ApiManagementGetWorkspaceNotification" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspacePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspacePolicy.json new file mode 100644 index 000000000000..4daaf9ad90a1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspacePolicy.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "WorkspacePolicy_Get", + "title": "ApiManagementGetWorkspacePolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspacePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspacePolicyFragment.json new file mode 100644 index 000000000000..c9e9f03cd430 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspacePolicyFragment.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "" + } + } + } + }, + "operationId": "WorkspacePolicyFragment_Get", + "title": "ApiManagementGetWorkspacePolicyFragment" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspacePolicyFragmentFormat.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspacePolicyFragmentFormat.json new file mode 100644 index 000000000000..1d8beac6938c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspacePolicyFragmentFormat.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "format": "rawxml", + "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", + "properties": { + "format": "rawxml", + "description": "A policy fragment example", + "value": "\r\n\t\t\t@{\n var guidBinary = new byte[16];\n Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10);\n long time = DateTime.Now.Ticks;\n byte[] bytes = new byte[6];\n unchecked\n {\n bytes[5] = (byte)(time >> 40);\n bytes[4] = (byte)(time >> 32);\n bytes[3] = (byte)(time >> 24);\n bytes[2] = (byte)(time >> 16);\n bytes[1] = (byte)(time >> 8);\n bytes[0] = (byte)(time);\n }\n Array.Copy(bytes, 0, guidBinary, 10, 6);\n return new Guid(guidBinary).ToString();\n }\n \r\n\t\t" + } + } + } + }, + "operationId": "WorkspacePolicyFragment_Get", + "title": "ApiManagementGetWorkspacePolicyFragmentFormat" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceProduct.json new file mode 100644 index 000000000000..75d09d7334aa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceProduct.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "unlimited", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "unlimited", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/unlimited", + "properties": { + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "approvalRequired": true, + "displayName": "Unlimited", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1 + } + } + } + }, + "operationId": "WorkspaceProduct_Get", + "title": "ApiManagementGetWorkspaceProduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceProductApiLink.json new file mode 100644 index 000000000000..af2071993b53 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceProductApiLink.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + } + }, + "operationId": "WorkspaceProductApiLink_Get", + "title": "ApiManagementGetWorkspaceProductApiLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceProductGroupLink.json new file mode 100644 index 000000000000..136d12b0b6e2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceProductGroupLink.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupLinkId": "link1", + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/groupLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/groupLinks/link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" + } + } + } + }, + "operationId": "WorkspaceProductGroupLink_Get", + "title": "ApiManagementGetWorkspaceProductGroupLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceProductPolicy.json new file mode 100644 index 000000000000..3b9a4a405401 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceProductPolicy.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "policyId": "policy", + "productId": "kjoshiarmTemplateProduct4", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/kjoshiarmTemplateProduct4/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "WorkspaceProductPolicy_Get", + "title": "ApiManagementGetWorkspaceProductPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceSchema.json new file mode 100644 index 000000000000..0dc6867f9744 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceSchema.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "schemaId": "schema1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "schema1", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "operationId": "WorkspaceGlobalSchema_Get", + "title": "ApiManagementGetWorkspaceSchema" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceSubscription.json new file mode 100644 index 000000000000..8dfe853f62a2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceSubscription.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "5931a769d8d14f0ad8ce13b8", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/5931a769d8d14f0ad8ce13b8", + "properties": { + "createdDate": "2017-06-02T17:59:06.223Z", + "displayName": "Unlimited", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", + "state": "submitted" + } + } + } + }, + "operationId": "WorkspaceSubscription_Get", + "title": "ApiManagementGetWorkspaceSubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceTag.json new file mode 100644 index 000000000000..6e2db2cbdabe --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceTag.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59306a29e4bbd510dc24e5f9", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + }, + "operationId": "WorkspaceTag_Get", + "title": "ApiManagementGetWorkspaceTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceTagApiLink.json new file mode 100644 index 000000000000..1a7717d4eb63 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceTagApiLink.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + } + }, + "operationId": "WorkspaceTagApiLink_Get", + "title": "ApiManagementGetWorkspaceTagApiLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceTagOperationLink.json new file mode 100644 index 000000000000..ce6da296bc42 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceTagOperationLink.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "operationLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" + } + } + } + }, + "operationId": "WorkspaceTagOperationLink_Get", + "title": "ApiManagementGetWorkspaceTagOperationLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceTagProductLink.json new file mode 100644 index 000000000000..2a4817123d75 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementGetWorkspaceTagProductLink.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" + } + } + } + }, + "operationId": "WorkspaceTagProductLink_Get", + "title": "ApiManagementGetWorkspaceTagProductLink" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApi.json new file mode 100644 index 000000000000..abbc87c500a2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApi.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "Api_GetEntityTag", + "title": "ApiManagementHeadApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiDiagnostic.json new file mode 100644 index 000000000000..1061a3fdc68d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiDiagnostic.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ApiDiagnostic_GetEntityTag", + "title": "ApiManagementHeadApiDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiIssue.json new file mode 100644 index 000000000000..81a911481822 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiIssue.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ApiIssue_GetEntityTag", + "title": "ApiManagementHeadApiIssue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiIssueAttachment.json new file mode 100644 index 000000000000..f65e866782ad --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiIssueAttachment.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "attachmentId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ApiIssueAttachment_GetEntityTag", + "title": "ApiManagementHeadApiIssueAttachment" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiIssueComment.json new file mode 100644 index 000000000000..8b1d98827dab --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiIssueComment.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "commentId": "599e29ab193c3c0bd0b3e2fb", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ApiIssueComment_GetEntityTag", + "title": "ApiManagementHeadApiIssueComment" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiOperation.json new file mode 100644 index 000000000000..b283396f49f1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiOperation.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "operationId": "57d2ef278aa04f0ad01d6cdc", + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ApiOperation_GetEntityTag", + "title": "ApiManagementHeadApiOperation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiOperationPolicy.json new file mode 100644 index 000000000000..48b69032d06d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiOperationPolicy.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "operationId": "5600b53ac53f5b0062080006", + "api-version": "2024-10-01-preview", + "apiId": "5600b539c53f5b0062040001", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ApiOperationPolicy_GetEntityTag", + "title": "ApiManagementHeadApiOperationPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiOperationTag.json new file mode 100644 index 000000000000..7b5180e9caf8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiOperationTag.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "operationId": "59d6bb8f1f7fab13dc67ec9a", + "api-version": "2024-10-01-preview", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + }, + "operationId": "Tag_GetEntityStateByOperation", + "title": "ApiManagementHeadApiOperationTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiPolicy.json new file mode 100644 index 000000000000..c5a2a46166cf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiPolicy.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ApiPolicy_GetEntityTag", + "title": "ApiManagementHeadApiPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiRelease.json new file mode 100644 index 000000000000..7aea66b683e5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiRelease.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "a1", + "releaseId": "5a7cb545298324c53224a799", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ApiRelease_GetEntityTag", + "title": "ApiManagementHeadApiRelease" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiSchema.json new file mode 100644 index 000000000000..96d05b23371c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiSchema.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ApiSchema_GetEntityTag", + "title": "ApiManagementHeadApiSchema" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiTag.json new file mode 100644 index 000000000000..441f8a4a7076 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiTag.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + }, + "operationId": "Tag_GetEntityStateByApi", + "title": "ApiManagementHeadApiTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiTagDescription.json new file mode 100644 index 000000000000..f52e2499a546 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiTagDescription.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagDescriptionId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + }, + "operationId": "ApiTagDescription_GetEntityTag", + "title": "ApiManagementHeadApiTagDescription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiVersionSet.json new file mode 100644 index 000000000000..976b12ebdb8d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiVersionSet.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "vs1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ApiVersionSet_GetEntityTag", + "title": "ApiManagementHeadApiVersionSet" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiWiki.json new file mode 100644 index 000000000000..23b82339b9bd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadApiWiki.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ApiWiki_GetEntityTag", + "title": "ApiManagementHeadApiWiki" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadAuthorizationServer.json new file mode 100644 index 000000000000..c73cab428ff8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadAuthorizationServer.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authsid": "newauthServer2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "AuthorizationServer_GetEntityTag", + "title": "ApiManagementHeadAuthorizationServer" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadBackend.json new file mode 100644 index 000000000000..3787f08f065d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadBackend.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "backendId": "sfbackend", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "Backend_GetEntityTag", + "title": "ApiManagementHeadBackend" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadCache.json new file mode 100644 index 000000000000..63dd3cb3bfd4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadCache.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "cacheId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "Cache_GetEntityTag", + "title": "ApiManagementHeadCache" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadCertificate.json new file mode 100644 index 000000000000..0a13848e9f92 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadCertificate.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "templateCert1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "Certificate_GetEntityTag", + "title": "ApiManagementHeadCertificate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadClientApplication.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadClientApplication.json new file mode 100644 index 000000000000..3cdd9b9e6311 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadClientApplication.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "clientApplicationId": "testAppId", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ClientApplication_GetEntityTag", + "title": "ApiManagementHeadProduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadContentTypeContentItem.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadContentTypeContentItem.json new file mode 100644 index 000000000000..b8ea032c7d1c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadContentTypeContentItem.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "contentTypeId": "page", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ContentItem_GetEntityTag", + "title": "ApiManagementHeadContentTypeContentItem" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadDelegationSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadDelegationSettings.json new file mode 100644 index 000000000000..7aae590a04f3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadDelegationSettings.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "DelegationSettings_GetEntityTag", + "title": "ApiManagementHeadDelegationSettings" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadDiagnostic.json new file mode 100644 index 000000000000..b7dfdb23c00d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadDiagnostic.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "Diagnostic_GetEntityTag", + "title": "ApiManagementHeadDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadDocumentation.json new file mode 100644 index 000000000000..6298b444d324 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadDocumentation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "documentationId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "Documentation_GetEntityTag", + "title": "ApiManagementHeadDocumentation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadEmailTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadEmailTemplate.json new file mode 100644 index 000000000000..fa2558b93693 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadEmailTemplate.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "templateName": "newIssueNotificationMessage" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "EmailTemplate_GetEntityTag", + "title": "ApiManagementHeadEmailTemplate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGateway.json new file mode 100644 index 000000000000..a81502c428e9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGateway.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "mygateway", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "Gateway_GetEntityTag", + "title": "ApiManagementHeadGateway" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGatewayApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGatewayApi.json new file mode 100644 index 000000000000..3d294a4888e9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGatewayApi.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "api1", + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + }, + "operationId": "GatewayApi_GetEntityTag", + "title": "ApiManagementHeadGatewayApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGatewayCertificateAuthority.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGatewayCertificateAuthority.json new file mode 100644 index 000000000000..52ca1929ff56 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGatewayCertificateAuthority.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "cert1", + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "GatewayCertificateAuthority_GetEntityTag", + "title": "ApiManagementHeadGatewayCertificateAuthority" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGatewayHostnameConfiguration.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGatewayHostnameConfiguration.json new file mode 100644 index 000000000000..79699881408f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGatewayHostnameConfiguration.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "hcId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "GatewayHostnameConfiguration_GetEntityTag", + "title": "ApiManagementHeadGatewayHostnameConfiguration" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGlobalSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGlobalSchema.json new file mode 100644 index 000000000000..587dcab841ad --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGlobalSchema.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "schemaId": "myschema", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "GlobalSchema_GetEntityTag", + "title": "ApiManagementHeadApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGraphQLApiResolver.json new file mode 100644 index 000000000000..6073db51e9b9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGraphQLApiResolver.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resolverId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "GraphQLApiResolver_GetEntityTag", + "title": "ApiManagementHeadGraphQLApiResolver" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGraphQLApiResolverPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGraphQLApiResolverPolicy.json new file mode 100644 index 000000000000..69e31ea2b58b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGraphQLApiResolverPolicy.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "5600b539c53f5b0062040001", + "policyId": "policy", + "resolverId": "5600b53ac53f5b0062080006", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "GraphQLApiResolverPolicy_GetEntityTag", + "title": "ApiManagementHeadGraphQLApiResolverPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGroup.json new file mode 100644 index 000000000000..cfb52ac42c18 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGroup.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "59306a29e4bbd510dc24e5f9", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "Group_GetEntityTag", + "title": "ApiManagementHeadGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGroupUser.json new file mode 100644 index 000000000000..8d07680b1a57 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadGroupUser.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "59306a29e4bbd510dc24e5f9", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512a88c680b" + }, + "responses": { + "204": {}, + "404": {} + }, + "operationId": "GroupUser_CheckEntityExists", + "title": "ApiManagementHeadGroupUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadIdentityProvider.json new file mode 100644 index 000000000000..f36c8e7018e2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadIdentityProvider.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "identityProviderName": "aadB2C", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "IdentityProvider_GetEntityTag", + "title": "ApiManagementHeadIdentityProvider" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadLogger.json new file mode 100644 index 000000000000..55edc401a409 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadLogger.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "loggerId": "templateLogger", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "Logger_GetEntityTag", + "title": "ApiManagementHeadLogger" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadNamedValue.json new file mode 100644 index 000000000000..510a2437b070 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadNamedValue.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "namedValueId": "testarmTemplateproperties2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "NamedValue_GetEntityTag", + "title": "ApiManagementHeadNamedValue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadNotificationRecipientEmail.json new file mode 100644 index 000000000000..4b3bc6fb2d25 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadNotificationRecipientEmail.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "email": "contoso@live.com", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {}, + "404": {} + }, + "operationId": "NotificationRecipientEmail_CheckEntityExists", + "title": "ApiManagementHeadNotificationRecipientEmail" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadNotificationRecipientUser.json new file mode 100644 index 000000000000..94f98a7e0c17 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadNotificationRecipientUser.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "576823d0a40f7e74ec07d642" + }, + "responses": { + "204": {}, + "404": {} + }, + "operationId": "NotificationRecipientUser_CheckEntityExists", + "title": "ApiManagementHeadNotificationRecipientUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadOpenIdConnectProvider.json new file mode 100644 index 000000000000..f930a81ab409 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadOpenIdConnectProvider.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "opid": "templateOpenIdConnect2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "OpenIdConnectProvider_GetEntityTag", + "title": "ApiManagementHeadOpenIdConnectProvider" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPolicy.json new file mode 100644 index 000000000000..b26d9140452d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPolicy.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "Policy_GetEntityTag", + "title": "ApiManagementHeadPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPolicyFragment.json new file mode 100644 index 000000000000..dfad86ce9499 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPolicyFragment.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "PolicyFragment_GetEntityTag", + "title": "ApiManagementHeadPolicyFragment" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPolicyRestriction.json new file mode 100644 index 000000000000..94be240ba80e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPolicyRestriction.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "policyRestrictionId": "policyRestriction1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "PolicyRestriction_GetEntityTag", + "title": "ApiManagementHeadPolicyRestriction" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPortalConfig.json new file mode 100644 index 000000000000..33dcc777c7b2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPortalConfig.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "portalConfigId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "PortalConfig_GetEntityTag", + "title": "ApiManagementHeadPortalConfig" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPortalRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPortalRevision.json new file mode 100644 index 000000000000..9568681e1202 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadPortalRevision.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "portalRevisionId": "20201112101010", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "PortalRevision_GetEntityTag", + "title": "ApiManagementHeadPortalRevision" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProduct.json new file mode 100644 index 000000000000..f9e4344d7910 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProduct.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "unlimited", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "Product_GetEntityTag", + "title": "ApiManagementHeadProduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductApi.json new file mode 100644 index 000000000000..d5afb94bcb95 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductApi.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "59306a29e4bbd510dc24e5f9", + "productId": "5931a75ae4bbd512a88c680b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + }, + "operationId": "ProductApi_CheckEntityExists", + "title": "ApiManagementHeadProductApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductGroup.json new file mode 100644 index 000000000000..88068f1f4949 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductGroup.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "59306a29e4bbd510dc24e5f9", + "productId": "5931a75ae4bbd512a88c680b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + }, + "operationId": "ProductGroup_CheckEntityExists", + "title": "ApiManagementHeadProductGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductPolicy.json new file mode 100644 index 000000000000..4923af59a2c9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductPolicy.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "policyId": "policy", + "productId": "unlimited", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ProductPolicy_GetEntityTag", + "title": "ApiManagementHeadProductPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductTag.json new file mode 100644 index 000000000000..2cb5710fd5ae --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductTag.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "59306a29e4bbd510dc24e5f8", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + }, + "operationId": "Tag_GetEntityStateByProduct", + "title": "ApiManagementHeadProductTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductWiki.json new file mode 100644 index 000000000000..822736fad422 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadProductWiki.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "ProductWiki_GetEntityTag", + "title": "ApiManagementHeadProductWiki" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadSignInSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadSignInSettings.json new file mode 100644 index 000000000000..f8780174e1b5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadSignInSettings.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "SignInSettings_GetEntityTag", + "title": "ApiManagementHeadSignInSettings" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadSignUpSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadSignUpSettings.json new file mode 100644 index 000000000000..b9addd645eb0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadSignUpSettings.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "SignUpSettings_GetEntityTag", + "title": "ApiManagementHeadSignUpSettings" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadSubscription.json new file mode 100644 index 000000000000..7e414c4dd79c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadSubscription.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "5931a769d8d14f0ad8ce13b8", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "Subscription_GetEntityTag", + "title": "ApiManagementHeadSubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadTag.json new file mode 100644 index 000000000000..bfc9414dbbbd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadTag.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + }, + "operationId": "Tag_GetEntityState", + "title": "ApiManagementHeadTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadTenantAccess.json new file mode 100644 index 000000000000..756ba9397c15 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadTenantAccess.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accessName": "access", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {} + }, + "operationId": "TenantAccess_GetEntityTag", + "title": "ApiManagementHeadTenantAccess" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadUser.json new file mode 100644 index 000000000000..b6bdf0bbc68d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadUser.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512a88c680b" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "User_GetEntityTag", + "title": "ApiManagementHeadUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspace.json new file mode 100644 index 000000000000..cfd544baa0c2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspace.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "Workspace_GetEntityTag", + "title": "ApiManagementHeadWorkspace" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApi.json new file mode 100644 index 000000000000..64f4359c1ff6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApi.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceApi_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiDiagnostic.json new file mode 100644 index 000000000000..231053610d08 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiDiagnostic.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceApiDiagnostic_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApiDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiOperation.json new file mode 100644 index 000000000000..ec9ff7e4f5a2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiOperation.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "operationId": "57d2ef278aa04f0ad01d6cdc", + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceApiOperation_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApiOperation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiOperationPolicy.json new file mode 100644 index 000000000000..7641eecd916d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiOperationPolicy.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "operationId": "5600b53ac53f5b0062080006", + "api-version": "2024-10-01-preview", + "apiId": "5600b539c53f5b0062040001", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceApiOperationPolicy_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApiOperationPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiPolicy.json new file mode 100644 index 000000000000..b146011d66d8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiPolicy.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceApiPolicy_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApiPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiRelease.json new file mode 100644 index 000000000000..73af9408e4c0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiRelease.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "a1", + "releaseId": "5a7cb545298324c53224a799", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceApiRelease_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApiRelease" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiSchema.json new file mode 100644 index 000000000000..30c16b683a55 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiSchema.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceApiSchema_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApiSchema" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiVersionSet.json new file mode 100644 index 000000000000..45d2bcbd93f2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceApiVersionSet.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "vs1", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceApiVersionSet_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApiVersionSet" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceBackend.json new file mode 100644 index 000000000000..886bbc1969b8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceBackend.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "backendId": "sfbackend", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceBackend_GetEntityTag", + "title": "ApiManagementHeadWorkspaceBackend" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceCertificate.json new file mode 100644 index 000000000000..f7116659d337 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceCertificate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "templateCert1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceCertificate_GetEntityTag", + "title": "ApiManagementWorkspaceHeadCertificate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceDiagnostic.json new file mode 100644 index 000000000000..a033b399e02b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceDiagnostic.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceDiagnostic_GetEntityTag", + "title": "ApiManagementHeadWorkspaceDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceGroup.json new file mode 100644 index 000000000000..03c69bf826fa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceGroup.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "59306a29e4bbd510dc24e5f9", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceGroup_GetEntityTag", + "title": "ApiManagementHeadWorkspaceGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceGroupUser.json new file mode 100644 index 000000000000..0fbf0ed7828d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceGroupUser.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "59306a29e4bbd510dc24e5f9", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512a88c680b", + "workspaceId": "wks1" + }, + "responses": { + "204": {}, + "404": {} + }, + "operationId": "WorkspaceGroupUser_CheckEntityExists", + "title": "ApiManagementHeadWorkspaceGroupUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceLogger.json new file mode 100644 index 000000000000..64e38a85eab2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceLogger.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "loggerId": "templateLogger", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceLogger_GetEntityTag", + "title": "ApiManagementHeadWorkspaceLogger" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceNamedValue.json new file mode 100644 index 000000000000..a9ec26b7f675 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceNamedValue.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "namedValueId": "testarmTemplateproperties2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceNamedValue_GetEntityTag", + "title": "ApiManagementHeadWorkspaceNamedValue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceNotificationRecipientEmail.json new file mode 100644 index 000000000000..6b406e76650f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceNotificationRecipientEmail.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "email": "contoso@live.com", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "204": {}, + "404": {} + }, + "operationId": "WorkspaceNotificationRecipientEmail_CheckEntityExists", + "title": "ApiManagementHeadWorkspaceNotificationRecipientEmail" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceNotificationRecipientUser.json new file mode 100644 index 000000000000..37991a4a4393 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceNotificationRecipientUser.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "576823d0a40f7e74ec07d642", + "workspaceId": "wks1" + }, + "responses": { + "204": {}, + "404": {} + }, + "operationId": "WorkspaceNotificationRecipientUser_CheckEntityExists", + "title": "ApiManagementHeadWorkspaceNotificationRecipientUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspacePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspacePolicy.json new file mode 100644 index 000000000000..85322b8f83c1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspacePolicy.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspacePolicy_GetEntityTag", + "title": "ApiManagementHeadWorkspacePolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspacePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspacePolicyFragment.json new file mode 100644 index 000000000000..f7731c77a1fa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspacePolicyFragment.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspacePolicyFragment_GetEntityTag", + "title": "ApiManagementHeadWorkspacePolicyFragment" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceProduct.json new file mode 100644 index 000000000000..c823288d168d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceProduct.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "unlimited", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceProduct_GetEntityTag", + "title": "ApiManagementHeadWorkspaceProduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceProductPolicy.json new file mode 100644 index 000000000000..bc56629a5da6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceProductPolicy.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "policyId": "policy", + "productId": "unlimited", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceProductPolicy_GetEntityTag", + "title": "ApiManagementHeadWorkspaceProductPolicy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceSchema.json new file mode 100644 index 000000000000..6c963997664a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceSchema.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "schemaId": "myschema", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceGlobalSchema_GetEntityTag", + "title": "ApiManagementHeadWorkspaceSchema" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceSubscription.json new file mode 100644 index 000000000000..aa7473e708dd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceSubscription.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "5931a769d8d14f0ad8ce13b8", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + }, + "operationId": "WorkspaceSubscription_GetEntityTag", + "title": "ApiManagementHeadWorkspaceSubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceTag.json new file mode 100644 index 000000000000..35846dd5113f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementHeadWorkspaceTag.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59306a29e4bbd510dc24e5f9", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + }, + "operationId": "WorkspaceTag_GetEntityState", + "title": "ApiManagementHeadWorkspaceTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementIdentityProviderListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementIdentityProviderListSecrets.json new file mode 100644 index 000000000000..bb4ceaef7a0d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementIdentityProviderListSecrets.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "identityProviderName": "aadB2C", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "clientSecret": "XXXXXXX" + } + } + }, + "operationId": "IdentityProvider_ListSecrets", + "title": "ApiManagementIdentityProviderListSecrets" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiDiagnostics.json new file mode 100644 index 000000000000..85259f7c66c7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiDiagnostics.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "value": [ + { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" + } + } + } + ] + } + } + }, + "operationId": "ApiDiagnostic_ListByService", + "title": "ApiManagementListApiDiagnostics" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiIssueAttachments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiIssueAttachments.json new file mode 100644 index 000000000000..826391806b9b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiIssueAttachments.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", + "properties": { + "content": "https://.../image.jpg", + "contentFormat": "link", + "title": "Issue attachment." + } + } + ] + } + } + }, + "operationId": "ApiIssueAttachment_ListByService", + "title": "ApiManagementListApiIssueAttachments" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiIssueComments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiIssueComments.json new file mode 100644 index 000000000000..761cba187e75 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiIssueComments.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", + "properties": { + "createdDate": "2018-02-01T22:21:20.467Z", + "text": "Issue comment.", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + ] + } + } + }, + "operationId": "ApiIssueComment_ListByService", + "title": "ApiManagementListApiIssueComments" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiIssues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiIssues.json new file mode 100644 index 000000000000..a292e5bbbab6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiIssues.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", + "properties": { + "description": "New API issue description", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "title": "New API issue", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + ] + } + } + }, + "operationId": "ApiIssue_ListByService", + "title": "ApiManagementListApiIssues" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiOperationPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiOperationPolicies.json new file mode 100644 index 000000000000..0251ceb77683 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiOperationPolicies.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "operationId": "599e29ab193c3c0bd0b3e2fb", + "api-version": "2024-10-01-preview", + "apiId": "599e2953193c3c0bd0b3e2fa", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/599e2953193c3c0bd0b3e2fa/operations/599e29ab193c3c0bd0b3e2fb/policies/policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n xxx\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + ] + } + } + }, + "operationId": "ApiOperationPolicy_ListByOperation", + "title": "ApiManagementListApiOperationPolicies" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiOperationTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiOperationTags.json new file mode 100644 index 000000000000..9a52d1fac4c4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiOperationTags.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "operationId": "57d2ef278aa04f0888cba3f6", + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1" + } + } + ] + } + } + }, + "operationId": "Tag_ListByOperation", + "title": "ApiManagementListApiOperationTags" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiOperations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiOperations.json new file mode 100644 index 000000000000..addb090996f6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiOperations.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "operationId": "57d2ef278aa04f0ad01d6cdc", + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 5, + "nextLink": "", + "value": [ + { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", + "properties": { + "method": "POST", + "displayName": "CancelOrder", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder" + } + }, + { + "name": "57d2ef278aa04f0ad01d6cda", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda", + "properties": { + "method": "POST", + "displayName": "GetMostRecentOrder", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetMostRecentOrder" + } + }, + { + "name": "57d2ef278aa04f0ad01d6cd9", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9", + "properties": { + "method": "POST", + "displayName": "GetOpenOrders", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOpenOrders" + } + }, + { + "name": "57d2ef278aa04f0ad01d6cdb", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb", + "properties": { + "method": "POST", + "displayName": "GetOrder", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOrder" + } + }, + { + "name": "57d2ef278aa04f0ad01d6cd8", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8", + "properties": { + "method": "POST", + "displayName": "submitOrder", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/submitOrder" + } + } + ] + } + } + }, + "operationId": "ApiOperation_ListByApi", + "title": "ApiManagementListApiOperations" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiOperationsByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiOperationsByTags.json new file mode 100644 index 000000000000..24faafc9f9d1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiOperationsByTags.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "a1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "value": [ + { + "operation": { + "name": "Create resource", + "method": "POST", + "description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend.", + "apiName": "Echo API", + "apiRevision": "1", + "id": "/apis/echo-api/operations/create-resource", + "urlTemplate": "/resource" + }, + "tag": { + "name": "awesomeTag", + "id": "/tags/apitag123" + } + } + ] + } + } + }, + "operationId": "Operation_ListByTags", + "title": "ApiManagementListApiOperationsByTags" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiPolicies.json new file mode 100644 index 000000000000..380ad783f977 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiPolicies.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "5600b59475ff190048040001", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b59475ff190048040001/policies/policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + ] + } + } + }, + "operationId": "ApiPolicy_ListByApi", + "title": "ApiManagementListApiPolicies" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiProducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiProducts.json new file mode 100644 index 000000000000..2f4e9fa53523 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiProducts.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/apis/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b539c53f5b0062060002", + "properties": { + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "approvalRequired": true, + "displayName": "Unlimited", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1 + } + } + ] + } + } + }, + "operationId": "ApiProduct_ListByApis", + "title": "ApiManagementListApiProducts" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiReleases.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiReleases.json new file mode 100644 index 000000000000..f3affb8353e4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiReleases.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "a1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/5a7cb545298324c53224a799", + "properties": { + "createdDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo", + "updatedDateTime": "2018-02-08T20:38:29.173Z" + } + } + ] + } + } + }, + "operationId": "ApiRelease_ListByService", + "title": "ApiManagementListApiReleases" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiRevisions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiRevisions.json new file mode 100644 index 000000000000..bc7fc276a1b9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiRevisions.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1;rev=1", + "apiRevision": "1", + "createdDateTime": "2018-02-01T22:21:20.467Z", + "isCurrent": true, + "isOnline": true, + "updatedDateTime": "2018-02-01T22:21:20.467Z" + } + ] + } + } + }, + "operationId": "ApiRevision_ListByService", + "title": "ApiManagementListApiRevisions" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiSchemas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiSchemas.json new file mode 100644 index 000000000000..7c6996d7574c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiSchemas.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "59d5b28d1f7fab116c282650", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "59d5b28e1f7fab116402044e", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d5b28d1f7fab116c282650/schemas/59d5b28e1f7fab116402044e", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + ] + } + } + }, + "operationId": "ApiSchema_ListByApi", + "title": "ApiManagementListApiSchemas" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiTagDescriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiTagDescriptions.json new file mode 100644 index 000000000000..3c9874925558 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiTagDescriptions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tagDescriptions/5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1", + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com", + "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002" + } + } + ] + } + } + }, + "operationId": "ApiTagDescription_ListByService", + "title": "ApiManagementListApiTagDescriptions" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiTags.json new file mode 100644 index 000000000000..cfb6ece2c8c3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiTags.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1" + } + } + ] + } + } + }, + "operationId": "Tag_ListByApi", + "title": "ApiManagementListApiTags" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiVersionSets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiVersionSets.json new file mode 100644 index 000000000000..77283086b077 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiVersionSets.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "vs1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1", + "properties": { + "description": "Version configuration", + "displayName": "api set 1", + "versioningScheme": "Segment" + } + }, + { + "name": "vs2", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs2", + "properties": { + "description": "Version configuration 2", + "displayName": "api set 2", + "versioningScheme": "Query" + } + } + ] + } + } + }, + "operationId": "ApiVersionSet_ListByService", + "title": "ApiManagementListApiVersionSets" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiWikis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiWikis.json new file mode 100644 index 000000000000..e656d59140a7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApiWikis.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + ] + } + } + }, + "operationId": "ApiWikis_List", + "title": "ApiManagementListApiWikis" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApis.json new file mode 100644 index 000000000000..b3c0d6d987f5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApis.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 4, + "nextLink": "", + "value": [ + { + "name": "a1", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "properties": { + "path": "api1", + "apiRevision": "1", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4", + "displayName": "api1", + "isCurrent": true, + "protocols": [ + "https" + ], + "serviceUrl": "http://echoapi.cloudapp.net/api" + } + }, + { + "name": "5a73933b8f27f7cc82a2d533", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a73933b8f27f7cc82a2d533", + "properties": { + "path": "api1", + "apiRevision": "1", + "apiVersion": "v1", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4", + "displayName": "api1", + "isCurrent": true, + "protocols": [ + "https" + ], + "serviceUrl": "http://echoapi.cloudapp.net/api" + } + }, + { + "name": "echo-api", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", + "properties": { + "path": "echo", + "apiRevision": "1", + "displayName": "Echo API", + "isCurrent": true, + "protocols": [ + "https" + ], + "serviceUrl": "http://echoapi.cloudapp.net/api" + } + }, + { + "name": "5a7390baa5816a110435aee0", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a7390baa5816a110435aee0", + "properties": { + "path": "vvv", + "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", + "apiRevision": "1", + "displayName": "Swagger Petstore Extensive", + "isCurrent": true, + "protocols": [ + "https" + ], + "serviceUrl": "http://petstore.swagger.wordnik.com/api" + } + } + ] + } + } + }, + "operationId": "Api_ListByService", + "title": "ApiManagementListApis" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApisByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApisByTags.json new file mode 100644 index 000000000000..75da2d01a80b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListApisByTags.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "value": [ + { + "api": { + "name": "Echo API", + "path": "echo", + "apiRevision": "1", + "id": "/apis/echo-api", + "isCurrent": true, + "serviceUrl": "http://echoapi.cloudapp.net/api" + }, + "tag": { + "name": "awesomeTag", + "id": "/tags/apitag123" + } + } + ] + } + } + }, + "operationId": "Api_ListByTags", + "title": "ApiManagementListApisByTags" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationAccessPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationAccessPolicies.json new file mode 100644 index 000000000000..b1e67999d40d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationAccessPolicies.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationId": "authz1", + "authorizationProviderId": "aadwithauthcode", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies/fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "properties": { + "appIds": [ + "d5f04bb0-ba78-4878-a43e-35a0b74fe315" + ], + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff" + } + }, + { + "name": "5585d6cd-2289-42e9-ab9b-3e2e23d74b4a", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies/5585d6cd-2289-42e9-ab9b-3e2e23d74b4a", + "properties": { + "appIds": [ + "d5f04bb0-ba78-4878-a43e-35a0b74fe315" + ], + "objectId": "5585d6cd-2289-42e9-ab9b-3e2e23d74b4a", + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff" + } + } + ] + } + } + }, + "operationId": "AuthorizationAccessPolicy_ListByAuthorization", + "title": "ApiManagementListAuthorizationAccessPolicies" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationProviders.json new file mode 100644 index 000000000000..53a5cc27f2af --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationProviders.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "aadwithauthcode", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", + "properties": { + "displayName": "aadwithauthcode", + "identityProvider": "aad", + "oauth2": { + "grantTypes": { + "authorizationCode": { + "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d", + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All", + "tenantId": "common" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + }, + { + "name": "aadwithclientcred", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred", + "properties": { + "displayName": "aadwithclientcred", + "identityProvider": "aad", + "oauth2": { + "grantTypes": { + "clientCredentials": { + "loginUri": "https://login.windows.net", + "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All", + "tenantId": "common" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + }, + { + "name": "google", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/google", + "properties": { + "displayName": "google", + "identityProvider": "google", + "oauth2": { + "grantTypes": { + "authorizationCode": { + "clientId": "99999999-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com", + "scopes": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + }, + { + "name": "eventbrite", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/eventbrite", + "properties": { + "displayName": "eventbrite", + "identityProvider": "oauth2", + "oauth2": { + "grantTypes": { + "authorizationCode": { + "authorizationUrl": "https://www.eventbrite.com/oauth/authorize", + "clientId": "clientid", + "refreshUrl": "https://www.eventbrite.com/oauth/token", + "scopes": null, + "tokenUrl": "https://www.eventbrite.com/oauth/token" + } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" + } + } + } + ] + } + } + }, + "operationId": "AuthorizationProvider_ListByService", + "title": "ApiManagementListAuthorizationProviders" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationServers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationServers.json new file mode 100644 index 000000000000..dcb49c805862 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationServers.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", + "properties": { + "description": "test server", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "defaultScope": "read write", + "displayName": "test2", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "resourceOwnerPassword": "pwd", + "resourceOwnerUsername": "un", + "supportState": true, + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "useInApiDocumentation": false, + "useInTestConsole": true + } + }, + { + "name": "newauthServer2", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer2", + "properties": { + "description": "test server", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientAuthenticationMethod": [ + "Basic" + ], + "clientId": "1", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "defaultScope": "read write", + "displayName": "test3", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "resourceOwnerPassword": "pwd", + "resourceOwnerUsername": "un", + "supportState": true, + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "useInApiDocumentation": true, + "useInTestConsole": false + } + } + ] + } + } + }, + "operationId": "AuthorizationServer_ListByService", + "title": "ApiManagementListAuthorizationServers" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationsAuthCode.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationsAuthCode.json new file mode 100644 index 000000000000..0e7b99220d91 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationsAuthCode.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationProviderId": "aadwithauthcode", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "AuthorizationCode", + "status": "Connected" + } + }, + { + "name": "authz2", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz2", + "properties": { + "authorizationType": "OAuth2", + "error": { + "code": "Unauthenticated", + "message": "This connection is not authenticated." + }, + "oauth2grantType": "AuthorizationCode", + "status": "Error" + } + } + ] + } + } + }, + "operationId": "Authorization_ListByAuthorizationProvider", + "title": "ApiManagementListAuthorizationsAuthCode" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationsClientCred.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationsClientCred.json new file mode 100644 index 000000000000..de9cd115ec59 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListAuthorizationsClientCred.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationProviderId": "aadwithclientcred", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz1", + "properties": { + "authorizationType": "OAuth2", + "oauth2grantType": "ClientCredentials", + "parameters": { + "clientId": "clientsecretid" + }, + "status": "Connected" + } + }, + { + "name": "authz2", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz2", + "properties": { + "authorizationType": "OAuth2", + "error": { + "code": "Unauthorized", + "message": "Failed to acquire access token for service using client credentials flow: IdentityProvider=aadwithclientcred. Correlation Id=6299d09b-03b7-46ed-b355-0453451d7e49, UTC TimeStamp=5/14/2022 4:53:19 PM, Error: Failed to exchange client credentials for token. Response code=Unauthorized, Details:\r\n{\"error\":\"invalid_client\",\"error_description\":\"AADSTS7000215: Invalid client secret provided. Ensure the secret being sent in the request is the client secret value, not the client secret ID, for a secret added to app 'clientsecretid'.\\r\\nTrace ID: 4a18d3cd-9ad5-4664-b3eb-daaa2f435f00\\r\\nCorrelation ID: dde60c16-35cb-4572-8226-bfb4233af8d7\\r\\nTimestamp: 2022-05-14 16:53:19Z\",\"error_codes\":[7000215],\"timestamp\":\"2022-05-14 16:53:19Z\",\"trace_id\":\"4a18d3cd-9ad5-4664-b3eb-daaa2f435f00\",\"correlation_id\":\"dde60c16-35cb-4572-8226-bfb4233af8d7\",\"error_uri\":\"https://login.windows.net/error?code=7000215\"}" + }, + "oauth2grantType": "ClientCredentials", + "parameters": { + "clientId": "clientsecretid" + }, + "status": "Error" + } + } + ] + } + } + }, + "operationId": "Authorization_ListByAuthorizationProvider", + "title": "ApiManagementListAuthorizationsClientCred" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListBackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListBackends.json new file mode 100644 index 000000000000..12598e33bbeb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListBackends.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", + "properties": { + "description": "description5308", + "credentials": { + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + } + }, + "proxy": { + "password": "", + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + }, + "url": "https://backendname2644/", + "protocol": "http" + } + }, + { + "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "properties": { + "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "managementEndpoints": [ + "https://somecluster.com" + ], + "maxPartitionResolutionRetries": 5, + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ] + } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" + } + } + ] + } + } + }, + "operationId": "Backend_ListByService", + "title": "ApiManagementListBackends" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListCaches.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListCaches.json new file mode 100644 index 000000000000..1137e89b8db4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListCaches.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "value": [ + { + "name": "c1", + "type": "Microsoft.ApiManagement/service/caches", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", + "properties": { + "description": "Redis cache instances in West India", + "connectionString": "{{5f7fbca77a891a2200f3db38}}", + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1", + "useFromLocation": "default" + } + } + ] + } + } + }, + "operationId": "Cache_ListByService", + "title": "ApiManagementListCaches" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListCertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListCertificates.json new file mode 100644 index 000000000000..aaa39a662b09 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListCertificates.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "templateCert1", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/kjoshiarmtemplateCert1", + "properties": { + "expirationDate": "2017-04-23T17:03:41Z", + "subject": "CN=mutual-authcert", + "thumbprint": "EBA************************48594A6" + } + }, + { + "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", + "properties": { + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" + } + } + ] + } + } + }, + "operationId": "Certificate_ListByService", + "title": "ApiManagementListCertificates" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListClientApplicationProductLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListClientApplicationProductLinks.json new file mode 100644 index 000000000000..e7168cb37366 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListClientApplicationProductLinks.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "clientApplicationId": "testAppId", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "link1", + "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter" + } + }, + { + "name": "link2", + "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link2", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited" + } + }, + { + "name": "link3", + "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link3", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/premium" + } + } + ] + } + } + }, + "operationId": "ClientApplicationProductLink_ListByClientApplications", + "title": "ApiManagementListProducts" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListClientApplicationSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListClientApplicationSecrets.json new file mode 100644 index 000000000000..d7c556e65c54 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListClientApplicationSecrets.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "clientApplicationId": "testAppId", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "entra": { + "clientSecret": "entraidapplicationsecret", + "expiresAt": "2026-04-17T09:51:58.9472187Z" + } + } + } + }, + "operationId": "ClientApplication_ListSecrets", + "title": "ApiManagementListProducts" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListClientApplications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListClientApplications.json new file mode 100644 index 000000000000..fce38a48ca9e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListClientApplications.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "testAppId", + "type": "Microsoft.ApiManagement/service/clientApplications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId", + "properties": { + "description": "This is just an example application", + "displayName": "Test Application", + "entraApplicationId": "00000000-0000-0000-0000-000000000000", + "entraTenantId": "00000000-0000-0000-0000-000000000010", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userID1", + "state": "active" + } + }, + { + "name": "testAppId2", + "type": "Microsoft.ApiManagement/service/clientApplications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId2", + "properties": { + "description": "This is just an example application 2", + "displayName": "Test Application 2", + "entraApplicationId": "00000000-0000-0000-0000-000000000001", + "entraTenantId": "00000000-0000-0000-0000-000000000011", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userID2", + "state": "active" + } + }, + { + "name": "testAppId3", + "type": "Microsoft.ApiManagement/service/clientApplications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId3", + "properties": { + "description": "This is just an example application 3", + "displayName": "Test Application 3", + "entraApplicationId": "00000000-0000-0000-0000-000000000002", + "entraTenantId": "00000000-0000-0000-0000-000000000012", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userID1", + "state": "active" + } + } + ] + } + } + }, + "operationId": "ClientApplication_ListByService", + "title": "ApiManagementListProducts" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListContentTypeContentItems.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListContentTypeContentItems.json new file mode 100644 index 000000000000..30685eab88a4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListContentTypeContentItems.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "contentTypeId": "page", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "properties": { + "en_us": { + "description": "Short story about the company.", + "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "keywords": "company, about", + "permalink": "/about", + "title": "About" + } + } + } + ] + } + } + }, + "operationId": "ContentItem_ListByService", + "title": "ApiManagementListContentTypeContentItems" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListContentTypes.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListContentTypes.json new file mode 100644 index 000000000000..55667b0142b4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListContentTypes.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "page", + "type": "Microsoft.ApiManagement/service/contentTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/contentTypes/page", + "properties": { + "name": "Page", + "schema": { + "additionalProperties": false, + "properties": { + "en_us": { + "type": "object", + "additionalProperties": false, + "properties": { + "description": { + "type": "string", + "description": "Page description. This property gets included in SEO attributes.", + "indexed": true, + "title": "Description" + }, + "documentId": { + "type": "string", + "description": "Reference to page content document.", + "title": "Document ID" + }, + "keywords": { + "type": "string", + "description": "Page keywords. This property gets included in SEO attributes.", + "indexed": true, + "title": "Keywords" + }, + "permalink": { + "type": "string", + "description": "Page permalink, e.g. '/about'.", + "indexed": true, + "title": "Permalink" + }, + "title": { + "type": "string", + "description": "Page title. This property gets included in SEO attributes.", + "indexed": true, + "title": "Title" + } + }, + "required": [ + "title", + "permalink", + "documentId" + ] + } + } + }, + "description": "A regular page", + "version": "1.0.0" + } + } + ] + } + } + }, + "operationId": "ContentType_ListByService", + "title": "ApiManagementListContentTypes" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListDiagnostics.json new file mode 100644 index 000000000000..a7484a808875 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListDiagnostics.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "value": [ + { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 0 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 0 + }, + "headers": [] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 0 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 0 + }, + "headers": [] + } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" + }, + "verbosity": "information" + } + }, + { + "name": "azuremonitor", + "type": "Microsoft.ApiManagement/service/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/azuremonitor", + "properties": { + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor", + "sampling": { + "percentage": 100, + "samplingType": "fixed" + } + } + } + ] + } + } + }, + "operationId": "Diagnostic_ListByService", + "title": "ApiManagementListDiagnostics" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListDocumentations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListDocumentations.json new file mode 100644 index 000000000000..5740f5687536 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListDocumentations.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "test", + "type": "Microsoft.ApiManagement/service/documentations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test", + "properties": { + "content": "Test content ", + "title": "test" + } + }, + { + "name": "test2", + "type": "Microsoft.ApiManagement/service/documentations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test2", + "properties": { + "content": "Test content ", + "title": "test" + } + }, + { + "name": "test3", + "type": "Microsoft.ApiManagement/service/documentations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test3", + "properties": { + "content": "Test content ", + "title": "test" + } + } + ] + } + } + }, + "operationId": "Documentation_ListByService", + "title": "ApiManagementListApis" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewayApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewayApis.json new file mode 100644 index 000000000000..082d16e59891 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewayApis.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "57681820a40f7eb6c49f6aca", + "type": "Microsoft.ApiManagement/service/gateways/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/57681820a40f7eb6c49f6aca", + "properties": { + "path": "suffix_57681820a40f7eb6c49f6ace", + "description": "description_57681820a40f7eb6c49f6acc", + "apiRevision": "1", + "displayName": "api_57681820a40f7eb6c49f6acb", + "isCurrent": true, + "protocols": [ + "https" + ], + "serviceUrl": "http://contoso/57681820a40f7eb6c49f6acd" + } + } + ] + } + } + }, + "operationId": "GatewayApi_ListByService", + "title": "ApiManagementListGatewayApis" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewayCertificateAuthorities.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewayCertificateAuthorities.json new file mode 100644 index 000000000000..33bc18c853ed --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewayCertificateAuthorities.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "cert1", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", + "properties": { + "isTrusted": false + } + }, + { + "name": "cert2", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert2", + "properties": { + "isTrusted": true + } + } + ] + } + } + }, + "operationId": "GatewayCertificateAuthority_ListByService", + "title": "ApiManagementListGatewaycertificateAuthorities" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewayConfigConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewayConfigConnection.json new file mode 100644 index 000000000000..73ee3a1a21aa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewayConfigConnection.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayName": "standard-gw-1", + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "gcc-1", + "type": "Microsoft.ApiManagement/gateways/configConnections", + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", + "properties": { + "defaultHostname": "gcc-1-ahg4t5iof8gaafex.standard-gw-1.gateway.eastus.azure-api.net", + "hostnames": [ + "gcc1standard-gw-1.gateway.eastus.azure-api.net" + ], + "provisioningState": "Succeeded", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001" + } + }, + { + "name": "gcc-2", + "type": "Microsoft.ApiManagement/gateways/configConnetions", + "etag": "AAAAAAAWKwo=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-2", + "properties": { + "defaultHostname": "gcc-2-ahg4t5iof8gaafex.standard-gw-1.gateway.eastus.azure-api.net", + "provisioningState": "Succeeded", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-002" + } + } + ] + } + } + }, + "operationId": "ApiGatewayConfigConnection_ListByGateway", + "title": "ApiManagementListGatewayConfigConnection" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewayHostnameConfigurations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewayHostnameConfigurations.json new file mode 100644 index 000000000000..f4b55177be43 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewayHostnameConfigurations.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", + "properties": { + "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "hostname": "*", + "negotiateClientCertificate": false + } + }, + { + "name": "default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/hostname1", + "properties": { + "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert2", + "hostname": "foo.bar.com", + "negotiateClientCertificate": true + } + } + ] + } + } + }, + "operationId": "GatewayHostnameConfiguration_ListByService", + "title": "ApiManagementListGatewayHostnameConfigurations" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGateways.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGateways.json new file mode 100644 index 000000000000..7eca412c25db --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGateways.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "a1", + "type": "Microsoft.ApiManagement/service/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location 1" + } + } + }, + { + "name": "5a73933b8f27f7cc82a2d533", + "type": "Microsoft.ApiManagement/service/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw2", + "properties": { + "description": "my gateway 2", + "locationData": { + "name": "my location 2" + } + } + } + ] + } + } + }, + "operationId": "Gateway_ListByService", + "title": "ApiManagementListGateways" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewaysBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewaysBySubscription.json new file mode 100644 index 000000000000..dec393035c0f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewaysBySubscription.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "standard-gw-1", + "type": "Microsoft.ApiManagement/gateways", + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1", + "location": "West US", + "properties": { + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "configurationApi": { + "hostname": "standard-gw-1.westus.configuration.gateway.azure-api.net" + }, + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "frontend": { + "defaultHostname": "standard-gw-1.westus.gateway.azure-api.net" + }, + "provisioningState": "Succeeded", + "targetProvisioningState": "" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdAt": "2021-06-16T09:40:00.7106733Z", + "createdBy": "bar@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "ReleaseName": "Z3", + "owner": "v-aswmoh" + } + }, + { + "name": "workspace-gw-2", + "type": "Microsoft.ApiManagement/gateways", + "etag": "AAAAAAAWKwo=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg2/providers/Microsoft.ApiManagement/gateways/workspace-gw-2", + "location": "East US", + "properties": { + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "provisioningState": "Succeeded", + "targetProvisioningState": "" + }, + "sku": { + "name": "WorkspaceGatewayPremium", + "capacity": 1 + }, + "tags": { + "Owner": "foo" + } + } + ] + } + } + }, + "operationId": "ApiGateway_List", + "title": "ApiManagementListGatewaysBySubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewaysBySubscriptionAndResourceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewaysBySubscriptionAndResourceGroup.json new file mode 100644 index 000000000000..5206e3339327 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGatewaysBySubscriptionAndResourceGroup.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "standard-gw-1", + "type": "Microsoft.ApiManagement/gateways", + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1", + "location": "West US", + "properties": { + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "configurationApi": { + "hostname": "standard-gw-1.westus.configuration.gateway.azure-api.net" + }, + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "frontend": { + "defaultHostname": "standard-gw-1.westus.gateway.azure-api.net" + }, + "provisioningState": "Succeeded", + "targetProvisioningState": "" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdAt": "2021-06-16T09:40:00.7106733Z", + "createdBy": "bar@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "ReleaseName": "Z3", + "owner": "v-aswmoh" + } + }, + { + "name": "standard-gw-2", + "type": "Microsoft.ApiManagement/gateways", + "etag": "AAAAAAAWKwo=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-2", + "location": "East US", + "properties": { + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn2/subnets/sn2" + } + }, + "configurationApi": { + "hostname": "standard-gw-2.eastus.configuration.gateway.azure-api.net" + }, + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "frontend": { + "defaultHostname": "standard-gw-2.eastus.gateway.azure-api.net" + }, + "provisioningState": "Succeeded", + "targetProvisioningState": "" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "tags": { + "Owner": "vitaliik" + } + } + ] + } + } + }, + "operationId": "ApiGateway_ListByResourceGroup", + "title": "ApiManagementListGatewaysBySubscriptionAndResourceGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGlobalSchemas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGlobalSchemas.json new file mode 100644 index 000000000000..ca839941ed32 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGlobalSchemas.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + }, + { + "name": "schema2", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema2", + "properties": { + "description": "sample schema description", + "document": { + "type": "object", + "$id": "https://example.com/person.schema.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "properties": { + "age": { + "type": "integer", + "description": "Age in years which must be equal to or greater than zero.", + "minimum": 0 + }, + "firstName": { + "type": "string", + "description": "The person's first name." + }, + "lastName": { + "type": "string", + "description": "The person's last name." + } + }, + "title": "Person" + }, + "schemaType": "json" + } + } + ] + } + } + }, + "operationId": "GlobalSchema_ListByService", + "title": "ApiManagementListSchemas" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGraphQLApiResolverPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGraphQLApiResolverPolicies.json new file mode 100644 index 000000000000..657c236be51e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGraphQLApiResolverPolicies.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "599e2953193c3c0bd0b3e2fa", + "resolverId": "599e29ab193c3c0bd0b3e2fb", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/599e2953193c3c0bd0b3e2fa/resolvers/599e29ab193c3c0bd0b3e2fb/policies/policy", + "properties": { + "value": "\r\n\r\n \r\n GET\r\n\r\n/api/users \r\n \r\n \r\n \r\n \r\n \r\n { \"id\": \"{{body.id}}\" } \r\n" + } + } + ] + } + } + }, + "operationId": "GraphQLApiResolverPolicy_ListByResolver", + "title": "ApiManagementListGraphQLApiResolverPolicies" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGraphQLApiResolvers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGraphQLApiResolvers.json new file mode 100644 index 000000000000..1d114a794fe7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGraphQLApiResolvers.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resolverId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc", + "properties": { + "path": "Query/users", + "description": "A GraphQL Resolver example", + "displayName": "Query Users" + } + }, + { + "name": "57d2ef278aa04f0ad01d6cda", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cda", + "properties": { + "path": "Mutation/makeUser", + "description": "A GraphQL Resolver example", + "displayName": "Mutation makeUser" + } + }, + { + "name": "57d2ef278aa04f0ad01d6cd9", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cd9", + "properties": { + "path": "User/id", + "description": "A GraphQL Resolver example", + "displayName": "Query for User Id field" + } + } + ] + } + } + }, + "operationId": "GraphQLApiResolver_ListByApi", + "title": "ApiManagementListGraphQLApiResolvers" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGroupUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGroupUsers.json new file mode 100644 index 000000000000..4b468c922b5b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGroupUsers.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "armTemplateUser1", + "type": "Microsoft.ApiManagement/service/groups/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/kjoshiarmTemplateUser1", + "properties": { + "email": "user1@live.com", + "firstName": "user1", + "identities": [ + { + "id": "user1@live.com", + "provider": "Basic" + } + ], + "lastName": "lastname1", + "note": "note for user 1", + "registrationDate": "2017-05-31T18:54:41.447Z", + "state": "active" + } + } + ] + } + } + }, + "operationId": "GroupUser_List", + "title": "ApiManagementListGroupUsers" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGroups.json new file mode 100644 index 000000000000..dbb78ba80031 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListGroups.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 4, + "nextLink": "", + "value": [ + { + "name": "5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020001", + "properties": { + "type": "system", + "description": "Administrators is a built-in group. Its membership is managed by the system. Microsoft Azure subscription administrators fall into this group.", + "builtIn": true, + "displayName": "Administrators" + } + }, + { + "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9", + "properties": { + "type": "external", + "description": "awesome group of people", + "builtIn": false, + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + }, + { + "name": "5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020002", + "properties": { + "type": "system", + "description": "Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.", + "builtIn": true, + "displayName": "Developers" + } + }, + { + "name": "5600b59375ff190048020003", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020003", + "properties": { + "type": "system", + "description": "Guests is a built-in group. Its membership is managed by the system. Unauthenticated users visiting the developer portal fall into this group.", + "builtIn": true, + "displayName": "Guests" + } + } + ] + } + } + }, + "operationId": "Group_ListByService", + "title": "ApiManagementListGroups" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListIdentityProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListIdentityProviders.json new file mode 100644 index 000000000000..7ad16fc2b755 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListIdentityProviders.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "Google", + "type": "Microsoft.ApiManagement/service/identityProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Google", + "properties": { + "type": "google", + "clientId": "googleId" + } + }, + { + "name": "Aad", + "type": "Microsoft.ApiManagement/service/identityProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Aad", + "properties": { + "type": "aad", + "allowedTenants": [ + "samiraad.onmicrosoft.com" + ], + "clientId": "aadapplicationid" + } + }, + { + "name": "AadB2C", + "type": "Microsoft.ApiManagement/service/identityProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C", + "properties": { + "type": "aadB2C", + "allowedTenants": [ + "samirtestbc.onmicrosoft.com" + ], + "clientId": "aadb2clientId", + "signinPolicyName": "B2C_1_Signin_Default", + "signupPolicyName": "B2C_1_Signup_Default" + } + } + ] + } + } + }, + "operationId": "IdentityProvider_ListByService", + "title": "ApiManagementListIdentityProviders" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListIssues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListIssues.json new file mode 100644 index 000000000000..446a9391a7a5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListIssues.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/issues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues/57d2ef278aa04f0ad01d6cdc", + "properties": { + "description": "New API issue description", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "title": "New API issue", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + ] + } + } + }, + "operationId": "Issue_ListByService", + "title": "ApiManagementListIssues" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListLoggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListLoggers.json new file mode 100644 index 000000000000..6303baf9695e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListLoggers.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "azuremonitor", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor", + "properties": { + "isBuffered": true, + "loggerType": "azureMonitor" + } + }, + { + "name": "vvktest", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/vvktest", + "properties": { + "credentials": { + "instrumentationKey": "{{Logger-Credentials-5b1a17ef2b3f91153004b10d}}" + }, + "isBuffered": true, + "loggerType": "applicationInsights" + } + }, + { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/applicationinsights", + "properties": { + "description": "miaoappinsight", + "credentials": { + "instrumentationKey": "{{Logger-Credentials-5b2056062b3f911ae84a3069}}" + }, + "isBuffered": true, + "loggerType": "applicationInsights" + } + } + ] + } + } + }, + "operationId": "Logger_ListByService", + "title": "ApiManagementListLoggers" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListNamedValues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListNamedValues.json new file mode 100644 index 000000000000..8d16c4739ec2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListNamedValues.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "592f1174cc83890dc4f32686", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/592f1174cc83890dc4f32686", + "properties": { + "displayName": "Logger-Credentials-592f1174cc83890dc4f32687", + "secret": false, + "value": "propValue" + } + }, + { + "name": "testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + }, + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" + }, + "secret": true, + "tags": [ + "foo", + "bar" + ] + } + } + ] + } + } + }, + "operationId": "NamedValue_ListByService", + "title": "ApiManagementListNamedValues" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListNotificationRecipientEmails.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListNotificationRecipientEmails.json new file mode 100644 index 000000000000..2f3dec549f64 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListNotificationRecipientEmails.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "contoso@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", + "properties": { + "email": "contoso@live.com" + } + }, + { + "name": "foobar!live", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", + "properties": { + "email": "foobar!live" + } + }, + { + "name": "foobar@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + ] + } + } + }, + "operationId": "NotificationRecipientEmail_ListByNotification", + "title": "ApiManagementListNotificationRecipientEmails" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListNotificationRecipientUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListNotificationRecipientUsers.json new file mode 100644 index 000000000000..4623137005c1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListNotificationRecipientUsers.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + ] + } + } + }, + "operationId": "NotificationRecipientUser_ListByNotification", + "title": "ApiManagementListNotificationRecipientUsers" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListNotifications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListNotifications.json new file mode 100644 index 000000000000..2e3ab53368d8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListNotifications.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 7, + "nextLink": "", + "value": [ + { + "name": "RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", + "properties": { + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + }, + "title": "Subscription requests (requiring approval)" + } + }, + { + "name": "PurchasePublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/PurchasePublisherNotificationMessage", + "properties": { + "description": "The following email recipients and users will receive email notifications about new API product subscriptions.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + ] + }, + "title": "New subscriptions" + } + }, + { + "name": "NewApplicationNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewApplicationNotificationMessage", + "properties": { + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com" + ], + "users": [] + }, + "title": "Application gallery requests" + } + }, + { + "name": "BCC", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/BCC", + "properties": { + "description": "The following recipients will receive blind carbon copies of all emails sent to developers.", + "recipients": { + "emails": [], + "users": [] + }, + "title": "BCC" + } + }, + { + "name": "NewIssuePublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewIssuePublisherNotificationMessage", + "properties": { + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.", + "recipients": { + "emails": [], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + ] + }, + "title": "New issue or comment" + } + }, + { + "name": "AccountClosedPublisher", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/AccountClosedPublisher", + "properties": { + "description": "The following email recipients and users will receive email notifications when developer closes his account", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com" + ], + "users": [] + }, + "title": "Close account message" + } + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/QuotaLimitApproachingPublisherNotificationMessage", + "properties": { + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.", + "recipients": { + "emails": [], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + ] + }, + "title": "Approaching subscription quota limit" + } + } + ] + } + } + }, + "operationId": "Notification_ListByService", + "title": "ApiManagementListNotifications" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListOpenIdConnectProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListOpenIdConnectProviders.json new file mode 100644 index 000000000000..36095571737e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListOpenIdConnectProviders.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "templateOpenIdConnect2", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", + "properties": { + "description": "open id provider template2", + "clientId": "oidprovidertemplate2", + "displayName": "templateoidprovider2", + "metadataEndpoint": "https://oidprovider-template2.net", + "useInApiDocumentation": true, + "useInTestConsole": false + } + } + ] + } + } + }, + "operationId": "OpenIdConnectProvider_ListByService", + "title": "ApiManagementListOpenIdConnectProviders" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListOperations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListOperations.json new file mode 100644 index 000000000000..e0208fa0e91d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListOperations.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ApiManagement/service/write", + "display": { + "description": "Create a new instance of API Management Service", + "operation": "Create a new instance of API Management Service", + "provider": "Microsoft API Management", + "resource": "Service" + } + }, + { + "name": "Microsoft.ApiManagement/service/read", + "display": { + "description": "Read metadata for an API Management Service instance", + "operation": "Read metadata for an API Management Service instance", + "provider": "Microsoft API Management", + "resource": "Service" + } + }, + { + "name": "Microsoft.ApiManagement/service/delete", + "display": { + "description": "Delete API Management Service instance", + "operation": "Delete API Management Service instance", + "provider": "Microsoft API Management", + "resource": "Service" + } + }, + { + "name": "Microsoft.ApiManagement/service/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "description": "Creates or updates the diagnostic setting for API Management service", + "operation": "Write diagnostic setting", + "provider": "Microsoft API Management", + "resource": "Service" + }, + "origin": "system" + }, + { + "name": "Microsoft.ApiManagement/service/tenant/operationResults/read", + "display": { + "description": "Get list of operation results or Get result of a specific operation", + "operation": "Get operation results or Get operation result", + "provider": "Microsoft API Management", + "resource": "Results of async operations" + } + } + ] + } + } + }, + "operationId": "ApiManagementOperations_List", + "title": "ApiManagementListOperations" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicies.json new file mode 100644 index 000000000000..460c37053f3a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicies.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "policy", + "type": "Microsoft.ApiManagement/service/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + ] + } + } + }, + "operationId": "Policy_ListByService", + "title": "ApiManagementListPolicies" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicyDescriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicyDescriptions.json new file mode 100644 index 000000000000..ac7dca8108d7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicyDescriptions.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "scope": "Api", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 2, + "value": [ + { + "name": "authentication-basic", + "type": "Microsoft.ApiManagement/service/policyDescriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-basic", + "properties": { + "description": "Authenticate with the backend service using Basic authentication. Use in the inbound section at API scope.", + "scope": 268435471 + } + }, + { + "name": "authentication-certificate", + "type": "Microsoft.ApiManagement/service/policyDescriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-certificate", + "properties": { + "description": "Authenticate with the backend service using a client certificate. Use in the inbound section at API scope.", + "scope": 268435471 + } + } + ] + } + } + }, + "operationId": "PolicyDescription_ListByService", + "title": "ApiManagementListPolicyDescriptions" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicyFragmentReferences.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicyFragmentReferences.json new file mode 100644 index 000000000000..13d175613d36 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicyFragmentReferences.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "policy", + "type": "Microsoft.ApiManagement/service/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy" + } + ] + } + } + }, + "operationId": "PolicyFragment_ListReferences", + "title": "ApiManagementListPolicyFragmentReferences" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicyFragments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicyFragments.json new file mode 100644 index 000000000000..d32dc6115c60 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicyFragments.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "" + } + } + ] + } + } + }, + "operationId": "PolicyFragment_ListByService", + "title": "ApiManagementListPolicyFragments" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicyRestrictions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicyRestrictions.json new file mode 100644 index 000000000000..fdf503036a1d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPolicyRestrictions.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "policyRestriction1", + "type": "Microsoft.ApiManagement/service/policyRestrictions", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", + "properties": { + "requireBase": "true", + "scope": "Sample Path to the policy document." + } + } + ] + } + } + }, + "operationId": "PolicyRestriction_ListByService", + "title": "ApiManagementListPolicyRestrictions" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPortalConfig.json new file mode 100644 index 000000000000..b39883de50dc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPortalConfig.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "default", + "type": "Microsoft.ApiManagement/service/portalconfigs", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", + "properties": { + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] + }, + "csp": { + "allowedSources": [ + "*.contoso.com" + ], + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ] + }, + "delegation": { + "delegateRegistration": false, + "delegateSubscription": false, + "delegationUrl": null, + "validationKey": null + }, + "enableBasicAuth": true, + "signin": { + "require": false + }, + "signup": { + "termsOfService": { + "requireConsent": false, + "text": "I agree to the service terms and conditions." + } + } + } + } + ] + } + } + }, + "operationId": "PortalConfig_ListByService", + "title": "ApiManagementListPortalConfig" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPortalRevisions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPortalRevisions.json new file mode 100644 index 000000000000..393a4248c47a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPortalRevisions.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "20201112000000", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112000000", + "properties": { + "description": "portal revision", + "createdDateTime": "2020-11-12T22:10:09.673Z", + "isCurrent": false, + "status": "completed", + "statusDetails": null, + "updatedDateTime": "2020-11-12T22:12:41.46Z" + } + }, + { + "name": "20201112101010", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010", + "properties": { + "description": "portal revision 1", + "createdDateTime": "2020-11-12T22:51:36.47Z", + "isCurrent": true, + "status": "completed", + "statusDetails": null, + "updatedDateTime": "2020-11-12T22:52:00.097Z" + } + } + ] + } + } + }, + "operationId": "PortalRevision_ListByService", + "title": "ApiManagementListPortalRevisions" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPortalSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPortalSettings.json new file mode 100644 index 000000000000..c21fa229ae60 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPortalSettings.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 3, + "value": [ + { + "name": "delegation", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation", + "properties": { + "enabled": false, + "subscriptions": { + "enabled": false + }, + "userRegistration": { + "enabled": false + } + } + }, + { + "name": "signin", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin", + "properties": { + "enabled": false + } + }, + { + "name": "signup", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup", + "properties": { + "enabled": true, + "termsOfService": { + "consentRequired": false, + "enabled": false, + "text": "Terms of service" + } + } + } + ] + } + } + }, + "operationId": "PortalSettings_ListByService", + "title": "ApiManagementListPortalSettings" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPrivateEndpointConnections.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPrivateEndpointConnections.json new file mode 100644 index 000000000000..1f80524f4114 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPrivateEndpointConnections.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "privateEndpointProxyName", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "description": "Please approve my request, thanks", + "actionsRequired": "None", + "status": "Pending" + }, + "provisioningState": "Pending" + } + }, + { + "name": "privateEndpointProxyName2", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName2", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName2" + }, + "privateLinkServiceConnectionState": { + "description": "Please approve my request, thanks", + "actionsRequired": "None", + "status": "Pending" + }, + "provisioningState": "Pending" + } + } + ] + } + } + }, + "operationId": "PrivateEndpointConnection_ListByService", + "title": "ApiManagementListPrivateEndpointConnections" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPrivateLinkGroupResources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPrivateLinkGroupResources.json new file mode 100644 index 000000000000..f3f9589e8a6e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListPrivateLinkGroupResources.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Gateway", + "type": "Microsoft.ApiManagement/service/privateLinkResources", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/Gateway", + "properties": { + "groupId": "Gateway", + "requiredMembers": [ + "Gateway" + ], + "requiredZoneNames": [ + "privateLink.azure-api.net" + ] + } + } + ] + } + } + }, + "operationId": "PrivateEndpointConnection_ListPrivateLinkResources", + "title": "ApiManagementListPrivateLinkGroupResources" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductApiLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductApiLinks.json new file mode 100644 index 000000000000..7d77e258fe8d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductApiLinks.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "product1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "link1", + "type": "Microsoft.ApiManagement/service/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + ] + } + } + }, + "operationId": "ProductApiLink_ListByProduct", + "title": "ApiManagementListProductApiLinks" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductApis.json new file mode 100644 index 000000000000..c67e88761580 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductApis.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "5768181ea40f7eb6c49f6ac7", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "57681820a40f7eb6c49f6aca", + "type": "Microsoft.ApiManagement/service/products/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7/apis/57681820a40f7eb6c49f6aca", + "properties": { + "path": "suffix_57681820a40f7eb6c49f6ace", + "description": "description_57681820a40f7eb6c49f6acc", + "apiRevision": "1", + "displayName": "api_57681820a40f7eb6c49f6acb", + "isCurrent": true, + "protocols": [ + "https" + ], + "serviceUrl": "http://contoso/57681820a40f7eb6c49f6acd" + } + } + ] + } + } + }, + "operationId": "ProductApi_ListByProduct", + "title": "ApiManagementListProductApis" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductGroupLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductGroupLinks.json new file mode 100644 index 000000000000..fcfb6dfc9077 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductGroupLinks.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "product1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "link1", + "type": "Microsoft.ApiManagement/service/products/groupLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1/groupLinks/link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" + } + } + ] + } + } + }, + "operationId": "ProductGroupLink_ListByProduct", + "title": "ApiManagementListProductGroupLinks" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductGroups.json new file mode 100644 index 000000000000..136cc0803238 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductGroups.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "5600b57e7e8880006a060002", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "5600b57e7e8880006a020001", + "type": "Microsoft.ApiManagement/service/products/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020001", + "properties": { + "type": "system", + "description": "Administrators is a built-in group. Its membership is managed by the system. Microsoft Azure subscription administrators fall into this group.", + "builtIn": true, + "displayName": "Administrators" + } + }, + { + "name": "5600b57e7e8880006a020002", + "type": "Microsoft.ApiManagement/service/products/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020002", + "properties": { + "type": "system", + "description": "Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.", + "builtIn": true, + "displayName": "Developers" + } + }, + { + "name": "5600b57e7e8880006a020003", + "type": "Microsoft.ApiManagement/service/products/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020003", + "properties": { + "type": "system", + "description": "Guests is a built-in group. Its membership is managed by the system. Unauthenticated users visiting the developer portal fall into this group.", + "builtIn": true, + "displayName": "Guests" + } + } + ] + } + } + }, + "operationId": "ProductGroup_ListByProduct", + "title": "ApiManagementListProductGroups" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductPolicies.json new file mode 100644 index 000000000000..f896f3409e39 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductPolicies.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "armTemplateProduct4", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/armTemplateProduct4/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + ] + } + } + }, + "operationId": "ProductPolicy_ListByProduct", + "title": "ApiManagementListProductPolicies" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductSubscriptions.json new file mode 100644 index 000000000000..8ca8d063af35 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductSubscriptions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "5600b57e7e8880006a060002", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "5600b57e7e8880006a070002", + "type": "Microsoft.ApiManagement/service/products/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/subscriptions/5600b57e7e8880006a070002", + "properties": { + "createdDate": "2015-09-22T01:57:18.723Z", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002", + "state": "active" + } + } + ] + } + } + }, + "operationId": "ProductSubscriptions_List", + "title": "ApiManagementListProductSubscriptions" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductTags.json new file mode 100644 index 000000000000..638daad8ce5c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductTags.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "57d2ef278aa04f0888cba3f1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1" + } + } + ] + } + } + }, + "operationId": "Tag_ListByProduct", + "title": "ApiManagementListProductTags" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductWikis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductWikis.json new file mode 100644 index 000000000000..fd652be3ecda --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductWikis.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + }, + { + "documentationId": "docId2" + } + ] + } + } + ] + } + } + }, + "operationId": "ProductWikis_list", + "title": "ApiManagementGetApiWiki" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProducts.json new file mode 100644 index 000000000000..a053dd96e86b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProducts.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "kjoshiarmtemplateCert1", + "type": "Microsoft.ApiManagement/service/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmtemplateCert1", + "properties": { + "description": "Development Product", + "displayName": "Dev", + "state": "published", + "subscriptionRequired": false + } + }, + { + "name": "starter", + "type": "Microsoft.ApiManagement/service/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter", + "properties": { + "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", + "approvalRequired": false, + "displayName": "Starter", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1, + "terms": "" + } + }, + { + "name": "unlimited", + "type": "Microsoft.ApiManagement/service/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited", + "properties": { + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "approvalRequired": true, + "displayName": "Unlimited", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1 + } + } + ] + } + } + }, + "operationId": "Product_ListByService", + "title": "ApiManagementListProducts" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductsByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductsByTags.json new file mode 100644 index 000000000000..3166e162688d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListProductsByTags.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "value": [ + { + "product": { + "name": "Starter", + "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", + "approvalRequired": false, + "id": "/products/starter", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1, + "terms": "" + }, + "tag": { + "name": "awesomeTag", + "id": "/tags/apitag123" + } + } + ] + } + } + }, + "operationId": "Product_ListByTags", + "title": "ApiManagementListProductsByTags" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListRegions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListRegions.json new file mode 100644 index 000000000000..9deeaf3d55c8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListRegions.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "West US", + "isDeleted": false, + "isMasterRegion": true + } + ] + } + } + }, + "operationId": "Region_ListByService", + "title": "ApiManagementListRegions" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSKUs-Consumption.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSKUs-Consumption.json new file mode 100644 index 000000000000..adcbaf428de9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSKUs-Consumption.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "capacity": null, + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Consumption" + } + } + ] + } + } + }, + "operationId": "ApiManagementServiceSkus_ListAvailableServiceSkus", + "title": "ApiManagementListSKUs-Consumption" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSKUs-Dedicated.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSKUs-Dedicated.json new file mode 100644 index 000000000000..a1870b7d8dbd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSKUs-Dedicated.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "capacity": { + "default": 1, + "maximum": 1, + "minimum": 1, + "scaleType": "none" + }, + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Developer" + } + }, + { + "capacity": { + "default": 1, + "maximum": 2, + "minimum": 1, + "scaleType": "manual" + }, + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Basic" + } + }, + { + "capacity": { + "default": 1, + "maximum": 4, + "minimum": 1, + "scaleType": "automatic" + }, + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Standard" + } + }, + { + "capacity": { + "default": 1, + "maximum": 10, + "minimum": 1, + "scaleType": "automatic" + }, + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Premium" + } + }, + { + "capacity": { + "default": 1, + "maximum": 1, + "minimum": 1, + "scaleType": "automatic" + }, + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Isolated" + } + } + ] + } + } + }, + "operationId": "ApiManagementServiceSkus_ListAvailableServiceSkus", + "title": "ApiManagementListSKUs-Dedicated" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSKUs-Gateways.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSKUs-Gateways.json new file mode 100644 index 000000000000..18ac2e0f7c7b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSKUs-Gateways.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayName": "apimService1", + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "capacity": { + "default": 1, + "maximum": 4, + "minimum": 1, + "scaleType": "Manual" + }, + "resourceType": "Microsoft.ApiManagement/gateways", + "sku": { + "name": "WorkspaceGatewayStandard" + } + }, + { + "capacity": { + "default": 1, + "maximum": 12, + "minimum": 1, + "scaleType": "Manual" + }, + "resourceType": "Microsoft.ApiManagement/gateways", + "sku": { + "name": "WorkspaceGatewayPremium" + } + } + ] + } + } + }, + "operationId": "ApiManagementGatewaySkus_ListAvailableSkus", + "title": "ApiManagementListSKUs-Gateways" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSecretsPortalSettingsValidationKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSecretsPortalSettingsValidationKey.json new file mode 100644 index 000000000000..6696a8f1b068 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSecretsPortalSettingsValidationKey.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "validationKey": "" + } + } + }, + "operationId": "DelegationSettings_ListSecrets", + "title": "ApiManagementListSecretsPortalSettings" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSecretsTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSecretsTenantAccess.json new file mode 100644 index 000000000000..a862730ea7df --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSecretsTenantAccess.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "accessName": "access", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "enabled": true, + "id": "5600b59375ff190048030003", + "primaryKey": "", + "secondaryKey": "" + } + } + }, + "operationId": "TenantAccess_ListSecrets", + "title": "ApiManagementListSecretsTenantAccess" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListServiceBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListServiceBySubscription.json new file mode 100644 index 000000000000..0adbc141d2be --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListServiceBySubscription.json @@ -0,0 +1,379 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "OGF-Z3-06162021-Premium", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789", + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d" + } + } + }, + "location": "East US", + "properties": { + "additionalLocations": [ + { + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net", + "location": "East US 2", + "publicIPAddresses": [ + "40.70.24.106" + ], + "sku": { + "name": "Premium", + "capacity": 1 + }, + "zones": [] + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "certificates": [], + "configurationApi": { + "legacyApi": "Enabled" + }, + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false" + }, + "developerPortalUrl": "https://ogf-z3-06162021-premium.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": false, + "hostName": "ogf-z3-06162021-premium.azure-api.net", + "negotiateClientCertificate": false + }, + { + "type": "Proxy", + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" + }, + "certificateSource": "Custom", + "defaultSslBinding": true, + "hostName": "gateway.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": true + }, + { + "type": "DeveloperPortal", + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" + }, + "certificateSource": "Custom", + "defaultSslBinding": false, + "hostName": "developer.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false + }, + { + "type": "Management", + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" + }, + "certificateSource": "Custom", + "defaultSslBinding": false, + "hostName": "mgmt.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false + }, + { + "type": "ConfigurationApi", + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" + }, + "certificateSource": "Custom", + "defaultSslBinding": false, + "hostName": "configuration-api.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.92.130.49" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "bar@contoso.com", + "publisherName": "Test Premium", + "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "systemData": { + "createdAt": "2021-06-16T09:40:00.7106733Z", + "createdBy": "bar@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "ReleaseName": "Z3", + "owner": "v-aswmoh" + } + }, + { + "name": "vvktestcons", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAWKwo=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/vvktestcons", + "location": "East US", + "properties": { + "createdAtUtc": "2020-08-10T18:07:23.4565211Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "disableGateway": false, + "enableClientCertificate": false, + "gatewayUrl": "https://vvktestcons.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "vvktestcons.azure-api.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "publisherEmail": "bar@contoso.com", + "publisherName": "vvktestcons", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + }, + "tags": { + "Owner": "vitaliik" + } + }, + { + "name": "OGF-Z3-06162021-Standard", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAWF7M=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Standard", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "347a5800-ca99-475a-9202-fe38ca79ee41", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789", + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d" + } + } + }, + "location": "East US", + "properties": { + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "configurationApi": { + "legacyApi": "Enabled" + }, + "createdAtUtc": "2021-06-16T09:39:58.6555759Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA": "true", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://ogf-z3-06162021-standard.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-standard-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://ogf-z3-06162021-standard.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "ogf-z3-06162021-standard.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://ogf-z3-06162021-standard.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://ogf-z3-06162021-standard.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.82.208.32" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "bar@contoso.com", + "publisherName": "Test Standard", + "scmUrl": "https://ogf-z3-06162021-standard.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Standard", + "capacity": 2 + }, + "systemData": { + "createdAt": "2021-06-16T09:39:58.4591834Z", + "createdBy": "bar@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2021-06-17T15:05:13.5494721Z", + "lastModifiedBy": "bar@contoso.com", + "lastModifiedByType": "User" + }, + "tags": {} + }, + { + "name": "ogf-dev-060921", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAWEFg=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/ogf-dev-060921", + "identity": { + "type": "SystemAssigned", + "principalId": "c9bd4c05-205e-4431-b232-112cf2e9e0aa", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + }, + "location": "East US", + "properties": { + "additionalLocations": [ + { + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-dev-060921-southcentralus-01.regional.azure-api.net", + "location": "South Central US", + "publicIPAddresses": [ + "13.84.208.29" + ], + "sku": { + "name": "Premium", + "capacity": 9 + }, + "zones": [] + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "certificates": [ + { + "certificate": { + "expiry": "2021-11-25T22:51:47+00:00", + "subject": "CN=*.apim.net", + "thumbprint": "4E8234312EC69245D1AE296C4882D46FB84076A3" + }, + "storeName": "Root" + } + ], + "configurationApi": { + "legacyApi": "Enabled" + }, + "createdAtUtc": "2021-06-09T10:06:22.2133978Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false" + }, + "developerPortalUrl": "https://ogf-dev-060921.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-dev-060921-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://ogf-dev-060921.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "ogf-dev-060921.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://ogf-dev-060921.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://ogf-dev-060921.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "168.62.39.172" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "v-ssaiprasan@microsoft.com", + "publisherName": "TechM", + "scmUrl": "https://ogf-dev-060921.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 3 + }, + "systemData": { + "createdAt": "2021-06-09T10:06:21.7336597Z", + "createdBy": "v-ssaiprasan@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2021-06-10T14:27:05.546816Z", + "lastModifiedBy": "v-ssaiprasan@microsoft.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + ] + } + } + }, + "operationId": "ApiManagementService_List", + "title": "ApiManagementListServiceBySubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListServiceBySubscriptionAndResourceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListServiceBySubscriptionAndResourceGroup.json new file mode 100644 index 000000000000..cc56d2613238 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListServiceBySubscriptionAndResourceGroup.json @@ -0,0 +1,371 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "OGF-Z3-06162021-Premium", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789", + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d" + } + } + }, + "location": "East US", + "properties": { + "additionalLocations": [ + { + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net", + "location": "East US 2", + "publicIPAddresses": [ + "40.70.24.106" + ], + "sku": { + "name": "Premium", + "capacity": 1 + }, + "zones": [] + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "certificates": [], + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false" + }, + "developerPortalUrl": "https://ogf-z3-06162021-premium.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": false, + "hostName": "ogf-z3-06162021-premium.azure-api.net", + "negotiateClientCertificate": false + }, + { + "type": "Proxy", + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" + }, + "certificateSource": "Custom", + "defaultSslBinding": true, + "hostName": "gateway.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": true + }, + { + "type": "DeveloperPortal", + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" + }, + "certificateSource": "Custom", + "defaultSslBinding": false, + "hostName": "developer.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false + }, + { + "type": "Management", + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" + }, + "certificateSource": "Custom", + "defaultSslBinding": false, + "hostName": "mgmt.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false + }, + { + "type": "ConfigurationApi", + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" + }, + "certificateSource": "Custom", + "defaultSslBinding": false, + "hostName": "configuration-api.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.92.130.49" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "bar@contoso.com", + "publisherName": "Test Premium", + "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "systemData": { + "createdAt": "2021-06-16T09:40:00.7106733Z", + "createdBy": "bar@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "ReleaseName": "Z3", + "owner": "v-aswmoh" + } + }, + { + "name": "vvktestcons", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAWKwo=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/vvktestcons", + "location": "East US", + "properties": { + "createdAtUtc": "2020-08-10T18:07:23.4565211Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "disableGateway": false, + "enableClientCertificate": false, + "gatewayUrl": "https://vvktestcons.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "vvktestcons.azure-api.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "publisherEmail": "bar@contoso.com", + "publisherName": "vvktestcons", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Consumption", + "capacity": 0 + }, + "tags": { + "Owner": "vitaliik" + } + }, + { + "name": "OGF-Z3-06162021-Standard", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAWF7M=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Standard", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "347a5800-ca99-475a-9202-fe38ca79ee41", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789", + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d" + } + } + }, + "location": "East US", + "properties": { + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "createdAtUtc": "2021-06-16T09:39:58.6555759Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA": "true", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://ogf-z3-06162021-standard.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-standard-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://ogf-z3-06162021-standard.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "ogf-z3-06162021-standard.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://ogf-z3-06162021-standard.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://ogf-z3-06162021-standard.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.82.208.32" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "bar@contoso.com", + "publisherName": "Test Standard", + "scmUrl": "https://ogf-z3-06162021-standard.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Standard", + "capacity": 2 + }, + "systemData": { + "createdAt": "2021-06-16T09:39:58.4591834Z", + "createdBy": "bar@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2021-06-17T15:05:13.5494721Z", + "lastModifiedBy": "bar@contoso.com", + "lastModifiedByType": "User" + }, + "tags": {} + }, + { + "name": "ogf-dev-060921", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAWEFg=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/ogf-dev-060921", + "identity": { + "type": "SystemAssigned", + "principalId": "c9bd4c05-205e-4431-b232-112cf2e9e0aa", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + }, + "location": "East US", + "properties": { + "additionalLocations": [ + { + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-dev-060921-southcentralus-01.regional.azure-api.net", + "location": "South Central US", + "publicIPAddresses": [ + "13.84.208.29" + ], + "sku": { + "name": "Premium", + "capacity": 9 + }, + "zones": [] + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "certificates": [ + { + "certificate": { + "expiry": "2021-11-25T22:51:47+00:00", + "subject": "CN=*.apim.net", + "thumbprint": "4E8234312EC69245D1AE296C4882D46FB84076A3" + }, + "storeName": "Root" + } + ], + "createdAtUtc": "2021-06-09T10:06:22.2133978Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false" + }, + "developerPortalUrl": "https://ogf-dev-060921.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-dev-060921-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://ogf-dev-060921.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "ogf-dev-060921.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://ogf-dev-060921.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://ogf-dev-060921.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "168.62.39.172" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "v-ssaiprasan@microsoft.com", + "publisherName": "TechM", + "scmUrl": "https://ogf-dev-060921.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 3 + }, + "systemData": { + "createdAt": "2021-06-09T10:06:21.7336597Z", + "createdBy": "v-ssaiprasan@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2021-06-10T14:27:05.546816Z", + "lastModifiedBy": "v-ssaiprasan@microsoft.com", + "lastModifiedByType": "User" + }, + "tags": {} + } + ] + } + } + }, + "operationId": "ApiManagementService_ListByResourceGroup", + "title": "ApiManagementListServiceBySubscriptionAndResourceGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSku.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSku.json new file mode 100644 index 000000000000..15040a132096 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSku.json @@ -0,0 +1,226 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Developer", + "capacity": { + "default": 1, + "maximum": 1, + "minimum": 1, + "scaleType": "None" + }, + "locationInfo": [ + { + "location": "centralindia", + "zoneDetails": [], + "zones": [] + } + ], + "locations": [ + "centralindia" + ], + "resourceType": "service", + "restrictions": [] + }, + { + "name": "Standard", + "capacity": { + "default": 1, + "maximum": 4, + "minimum": 1, + "scaleType": "Automatic" + }, + "locationInfo": [ + { + "location": "centralindia", + "zoneDetails": [], + "zones": [] + } + ], + "locations": [ + "centralindia" + ], + "resourceType": "service", + "restrictions": [] + }, + { + "name": "Premium", + "capacity": { + "default": 1, + "maximum": 10, + "minimum": 1, + "scaleType": "Automatic" + }, + "locationInfo": [ + { + "location": "centralindia", + "zoneDetails": [], + "zones": [] + } + ], + "locations": [ + "centralindia" + ], + "resourceType": "service", + "restrictions": [] + }, + { + "name": "Basic", + "capacity": { + "default": 1, + "maximum": 2, + "minimum": 1, + "scaleType": "Manual" + }, + "locationInfo": [ + { + "location": "centralindia", + "zoneDetails": [], + "zones": [] + } + ], + "locations": [ + "centralindia" + ], + "resourceType": "service", + "restrictions": [] + }, + { + "name": "Consumption", + "capacity": { + "default": 0, + "maximum": 0, + "minimum": 0, + "scaleType": "None" + }, + "locationInfo": [ + { + "location": "centralindia", + "zoneDetails": [], + "zones": [] + } + ], + "locations": [ + "centralindia" + ], + "resourceType": "service", + "restrictions": [] + }, + { + "name": "Developer", + "capacity": { + "default": 1, + "maximum": 1, + "minimum": 1, + "scaleType": "None" + }, + "locationInfo": [ + { + "location": "uaenorth", + "zoneDetails": [], + "zones": [] + } + ], + "locations": [ + "uaenorth" + ], + "resourceType": "service", + "restrictions": [] + }, + { + "name": "Standard", + "capacity": { + "default": 1, + "maximum": 4, + "minimum": 1, + "scaleType": "Automatic" + }, + "locationInfo": [ + { + "location": "uaenorth", + "zoneDetails": [], + "zones": [] + } + ], + "locations": [ + "uaenorth" + ], + "resourceType": "service", + "restrictions": [] + }, + { + "name": "Premium", + "capacity": { + "default": 1, + "maximum": 10, + "minimum": 1, + "scaleType": "Automatic" + }, + "locationInfo": [ + { + "location": "uaenorth", + "zoneDetails": [], + "zones": [] + } + ], + "locations": [ + "uaenorth" + ], + "resourceType": "service", + "restrictions": [] + }, + { + "name": "Basic", + "capacity": { + "default": 1, + "maximum": 2, + "minimum": 1, + "scaleType": "Manual" + }, + "locationInfo": [ + { + "location": "uaenorth", + "zoneDetails": [], + "zones": [] + } + ], + "locations": [ + "uaenorth" + ], + "resourceType": "service", + "restrictions": [] + }, + { + "name": "Developer", + "capacity": { + "default": 1, + "maximum": 1, + "minimum": 1, + "scaleType": "None" + }, + "locationInfo": [ + { + "location": "australiacentral", + "zoneDetails": [], + "zones": [] + } + ], + "locations": [ + "australiacentral" + ], + "resourceType": "service", + "restrictions": [] + } + ] + } + } + }, + "operationId": "ApiManagementSkus_List", + "title": "Lists all available Resource SKUs" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSubscriptions.json new file mode 100644 index 000000000000..42e3fa03815e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListSubscriptions.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "5600b59475ff190048070001", + "type": "Microsoft.ApiManagement/service/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5600b59475ff190048070001", + "properties": { + "createdDate": "2015-09-22T01:57:40.3Z", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001", + "state": "active" + } + }, + { + "name": "56eaed3dbaf08b06e46d27fe", + "type": "Microsoft.ApiManagement/service/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/56eaed3dbaf08b06e46d27fe", + "properties": { + "createdDate": "2016-03-17T17:45:33.837Z", + "displayName": "Starter", + "expirationDate": "2016-04-01T00:00:00Z", + "notificationDate": "2016-03-20T00:00:00Z", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001", + "startDate": "2016-03-17T00:00:00Z", + "state": "active" + } + }, + { + "name": "5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8", + "properties": { + "createdDate": "2017-06-02T17:59:06.223Z", + "displayName": "Unlimited", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "state": "submitted" + } + } + ] + } + } + }, + "operationId": "Subscription_List", + "title": "ApiManagementListSubscriptions" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTagApiLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTagApiLinks.json new file mode 100644 index 000000000000..5437aa26e4cd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTagApiLinks.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" + } + } + ] + } + } + }, + "operationId": "TagApiLink_ListByProduct", + "title": "ApiManagementListTagApiLinks" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTagOperationLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTagOperationLinks.json new file mode 100644 index 000000000000..0c3698a41475 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTagOperationLinks.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" + } + } + ] + } + } + }, + "operationId": "TagOperationLink_ListByProduct", + "title": "ApiManagementListTagOperationLinks" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTagProductLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTagProductLinks.json new file mode 100644 index 000000000000..9189f87c9912 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTagProductLinks.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" + } + } + ] + } + } + }, + "operationId": "TagProductLink_ListByProduct", + "title": "ApiManagementListTagProductLinks" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTagResources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTagResources.json new file mode 100644 index 000000000000..5b7d1d6a546f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTagResources.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "operation": { + "name": "Create resource", + "method": "POST", + "description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend.", + "apiName": "Echo API", + "apiRevision": "1", + "id": "/apis/echo-api/operations/create-resource", + "urlTemplate": "/resource" + }, + "tag": { + "name": "awesomeTag", + "id": "/tags/apitag123" + } + }, + { + "api": { + "name": "Echo API", + "path": "echo", + "apiRevision": "1", + "id": "/apis/echo-api", + "isCurrent": true, + "serviceUrl": "http://echoapi.cloudapp.net/api" + }, + "tag": { + "name": "awesomeTag", + "id": "/tags/apitag123" + } + }, + { + "product": { + "name": "Starter", + "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", + "approvalRequired": false, + "id": "/products/starter", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1, + "terms": "" + }, + "tag": { + "name": "awesomeTag", + "id": "/tags/apitag123" + } + } + ] + } + } + }, + "operationId": "TagResource_ListByService", + "title": "ApiManagementListTagResources" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTags.json new file mode 100644 index 000000000000..a698fa1b5ec2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTags.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020001", + "properties": { + "displayName": "tag1" + } + }, + { + "name": "5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020002", + "properties": { + "displayName": "tag2" + } + } + ] + } + } + }, + "operationId": "Tag_ListByService", + "title": "ApiManagementListTags" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTemplates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTemplates.json new file mode 100644 index 000000000000..e84d6a156393 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTemplates.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "ApplicationApprovedNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/ApplicationApprovedNotificationMessage", + "properties": { + "description": "Developers who submitted their application for publication in the application gallery on the developer portal receive this email after their submission is approved.", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

\r\n We are happy to let you know that your request to publish the $AppName application in the application gallery has been approved. Your application has been published and can be viewed here.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "isDefault": true, + "parameters": [ + { + "name": "AppId", + "title": "Application id" + }, + { + "name": "AppName", + "title": "Application name" + }, + { + "name": "DevFirstName", + "title": "Developer first name" + }, + { + "name": "DevLastName", + "title": "Developer last name" + }, + { + "name": "OrganizationName", + "title": "Organization name" + }, + { + "name": "DevPortalUrl", + "title": "Developer portal URL" + } + ], + "subject": "Your application $AppName is published in the application gallery", + "title": "Application gallery submission approved" + } + } + ] + } + } + }, + "operationId": "EmailTemplate_ListByService", + "title": "ApiManagementListTemplates" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTenantAccess.json new file mode 100644 index 000000000000..eb581e057bd2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTenantAccess.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "access", + "type": "Microsoft.ApiManagement/service/tenant", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", + "properties": { + "enabled": true + } + } + ] + } + } + }, + "operationId": "TenantAccess_ListByService", + "title": "ApiManagementListTenantAccess" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTenantSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTenantSettings.json new file mode 100644 index 000000000000..e1773154c68a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListTenantSettings.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "public", + "type": "Microsoft.ApiManagement/service/settings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/settings/public", + "properties": { + "settings": { + "CustomPortalSettings.DelegatedSubscriptionEnabled": "False", + "CustomPortalSettings.DelegationEnabled": "False", + "CustomPortalSettings.DelegationUrl": "", + "CustomPortalSettings.UserRegistrationTerms": null, + "CustomPortalSettings.UserRegistrationTermsConsentRequired": "False", + "CustomPortalSettings.UserRegistrationTermsEnabled": "False" + } + } + } + ] + } + } + }, + "operationId": "TenantSettings_ListByService", + "title": "ApiManagementListTenantSettings" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListUserGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListUserGroups.json new file mode 100644 index 000000000000..552239b48973 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListUserGroups.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "57681833a40f7eb6c49f6acf" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "5600b57e7e8880006a020002", + "type": "Microsoft.ApiManagement/service/users/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/groups/5600b57e7e8880006a020002", + "properties": { + "type": "system", + "description": "Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.", + "builtIn": true, + "displayName": "Developers" + } + } + ] + } + } + }, + "operationId": "UserGroup_List", + "title": "ApiManagementListUserGroups" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListUserIdentities.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListUserIdentities.json new file mode 100644 index 000000000000..4f6c7d3027d4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListUserIdentities.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "57f2af53bb17172280f44057" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "id": "086cf9********55ab", + "provider": "Microsoft" + } + ] + } + } + }, + "operationId": "UserIdentities_List", + "title": "ApiManagementListUserIdentities" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListUserSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListUserSubscriptions.json new file mode 100644 index 000000000000..aabbb1a3eacc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListUserSubscriptions.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "57681833a40f7eb6c49f6acf" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "name": "57681850a40f7eb6c49f6ae3", + "type": "Microsoft.ApiManagement/service/users/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6ae3", + "properties": { + "createdDate": "2016-06-20T16:22:39.547Z", + "displayName": "57681850a40f7eb6c49f6ae5", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7", + "startDate": "2016-06-20T00:00:00Z", + "state": "active" + } + }, + { + "name": "57681850a40f7eb6c49f6b2b", + "type": "Microsoft.ApiManagement/service/users/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6b2b", + "properties": { + "createdDate": "2016-06-20T16:22:41.103Z", + "displayName": "57681850a40f7eb6c49f6b2d", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7", + "startDate": "2016-06-20T00:00:00Z", + "state": "active" + } + } + ] + } + } + }, + "operationId": "UserSubscription_List", + "title": "ApiManagementListUserSubscriptions" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListUsers.json new file mode 100644 index 000000000000..93ea3d563fbf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListUsers.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "1", + "type": "Microsoft.ApiManagement/service/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "properties": { + "email": "admin@live.com", + "firstName": "Administrator", + "identities": [ + { + "id": "admin@live.com", + "provider": "Azure" + } + ], + "lastName": "", + "registrationDate": "2015-09-22T01:57:39.677Z", + "state": "active" + } + }, + { + "name": "56eaec62baf08b06e46d27fd", + "type": "Microsoft.ApiManagement/service/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd", + "properties": { + "email": "foo.bar.83@gmail.com", + "firstName": "foo", + "identities": [ + { + "id": "foo.bar.83@gmail.com", + "provider": "Basic" + } + ], + "lastName": "bar", + "registrationDate": "2016-03-17T17:41:56.327Z", + "state": "active" + } + }, + { + "name": "5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "properties": { + "email": "foobar@outlook.com", + "firstName": "foo", + "identities": [ + { + "id": "*************", + "provider": "Microsoft" + } + ], + "lastName": "bar", + "registrationDate": "2017-06-02T17:58:50.357Z", + "state": "active" + } + } + ] + } + } + }, + "operationId": "User_ListByService", + "title": "ApiManagementListUsers" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiDiagnostics.json new file mode 100644 index 000000000000..f2756800e312 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiDiagnostics.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "value": [ + { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" + } + } + } + ] + } + } + }, + "operationId": "WorkspaceApiDiagnostic_ListByWorkspace", + "title": "ApiManagementListWorkspaceApiDiagnostics" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiOperationPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiOperationPolicies.json new file mode 100644 index 000000000000..dd4bf9a817f7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiOperationPolicies.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "operationId": "599e29ab193c3c0bd0b3e2fb", + "api-version": "2024-10-01-preview", + "apiId": "599e2953193c3c0bd0b3e2fa", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/599e2953193c3c0bd0b3e2fa/operations/599e29ab193c3c0bd0b3e2fb/policies/policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n xxx\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + ] + } + } + }, + "operationId": "WorkspaceApiOperationPolicy_ListByOperation", + "title": "ApiManagementListWorkspaceApiOperationPolicies" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiOperations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiOperations.json new file mode 100644 index 000000000000..9637aec50ba6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiOperations.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 5, + "nextLink": "", + "value": [ + { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", + "properties": { + "method": "POST", + "displayName": "CancelOrder", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder" + } + }, + { + "name": "57d2ef278aa04f0ad01d6cda", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda", + "properties": { + "method": "POST", + "displayName": "GetMostRecentOrder", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetMostRecentOrder" + } + }, + { + "name": "57d2ef278aa04f0ad01d6cd9", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9", + "properties": { + "method": "POST", + "displayName": "GetOpenOrders", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOpenOrders" + } + }, + { + "name": "57d2ef278aa04f0ad01d6cdb", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb", + "properties": { + "method": "POST", + "displayName": "GetOrder", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOrder" + } + }, + { + "name": "57d2ef278aa04f0ad01d6cd8", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8", + "properties": { + "method": "POST", + "displayName": "submitOrder", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/submitOrder" + } + } + ] + } + } + }, + "operationId": "WorkspaceApiOperation_ListByApi", + "title": "ApiManagementListWorkspaceApiOperations" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiPolicies.json new file mode 100644 index 000000000000..0623a1c37e1d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiPolicies.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "5600b59475ff190048040001", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b59475ff190048040001/policies/policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + ] + } + } + }, + "operationId": "WorkspaceApiPolicy_ListByApi", + "title": "ApiManagementListWorkspaceApiPolicies" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiReleases.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiReleases.json new file mode 100644 index 000000000000..2b4895605448 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiReleases.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "a1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/5a7cb545298324c53224a799", + "properties": { + "createdDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo", + "updatedDateTime": "2018-02-08T20:38:29.173Z" + } + } + ] + } + } + }, + "operationId": "WorkspaceApiRelease_ListByService", + "title": "ApiManagementListWorkspaceApiReleases" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiRevisions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiRevisions.json new file mode 100644 index 000000000000..fa06426b8e71 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiRevisions.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1;rev=1", + "apiRevision": "1", + "createdDateTime": "2018-02-01T22:21:20.467Z", + "isCurrent": true, + "isOnline": true, + "updatedDateTime": "2018-02-01T22:21:20.467Z" + } + ] + } + } + }, + "operationId": "WorkspaceApiRevision_ListByService", + "title": "ApiManagementListWorkspaceApiRevisions" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiSchemas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiSchemas.json new file mode 100644 index 000000000000..b830d651e81e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiSchemas.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "apiId": "59d5b28d1f7fab116c282650", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "59d5b28e1f7fab116402044e", + "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d5b28d1f7fab116c282650/schemas/59d5b28e1f7fab116402044e", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + ] + } + } + }, + "operationId": "WorkspaceApiSchema_ListByApi", + "title": "ApiManagementListWorkspaceApiSchemas" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiVersionSets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiVersionSets.json new file mode 100644 index 000000000000..edd1ce225915 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApiVersionSets.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "vs1", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs1", + "properties": { + "description": "Version configuration", + "displayName": "api set 1", + "versioningScheme": "Segment" + } + }, + { + "name": "vs2", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs2", + "properties": { + "description": "Version configuration 2", + "displayName": "api set 2", + "versioningScheme": "Query" + } + } + ] + } + } + }, + "operationId": "WorkspaceApiVersionSet_ListByService", + "title": "ApiManagementListWorkspaceApiVersionSets" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApis.json new file mode 100644 index 000000000000..61b7e7aa47b0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceApis.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 4, + "nextLink": "", + "value": [ + { + "name": "a1", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", + "properties": { + "path": "api1", + "apiRevision": "1", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4", + "displayName": "api1", + "isCurrent": true, + "protocols": [ + "https" + ], + "serviceUrl": "http://echoapi.cloudapp.net/api" + } + }, + { + "name": "5a73933b8f27f7cc82a2d533", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5a73933b8f27f7cc82a2d533", + "properties": { + "path": "api1", + "apiRevision": "1", + "apiVersion": "v1", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4", + "displayName": "api1", + "isCurrent": true, + "protocols": [ + "https" + ], + "serviceUrl": "http://echoapi.cloudapp.net/api" + } + }, + { + "name": "echo-api", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api", + "properties": { + "path": "echo", + "apiRevision": "1", + "displayName": "Echo API", + "isCurrent": true, + "protocols": [ + "https" + ], + "serviceUrl": "http://echoapi.cloudapp.net/api" + } + }, + { + "name": "5a7390baa5816a110435aee0", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5a7390baa5816a110435aee0", + "properties": { + "path": "vvv", + "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", + "apiRevision": "1", + "displayName": "Swagger Petstore Extensive", + "isCurrent": true, + "protocols": [ + "https" + ], + "serviceUrl": "http://petstore.swagger.wordnik.com/api" + } + } + ] + } + } + }, + "operationId": "WorkspaceApi_ListByService", + "title": "ApiManagementListWorkspaceApis" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceBackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceBackends.json new file mode 100644 index 000000000000..943de3fec485 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceBackends.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", + "properties": { + "description": "description5308", + "credentials": { + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + } + }, + "proxy": { + "password": "", + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + }, + "url": "https://backendname2644/", + "protocol": "http" + } + }, + { + "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "properties": { + "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "managementEndpoints": [ + "https://somecluster.com" + ], + "maxPartitionResolutionRetries": 5, + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ] + } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" + } + } + ] + } + } + }, + "operationId": "WorkspaceBackend_ListByWorkspace", + "title": "ApiManagementListWorkspaceBackends" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceCertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceCertificates.json new file mode 100644 index 000000000000..6bb1fc4323e8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceCertificates.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "templateCert1", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/kjoshiarmtemplateCert1", + "properties": { + "expirationDate": "2017-04-23T17:03:41Z", + "subject": "CN=mutual-authcert", + "thumbprint": "EBA************************48594A6" + } + }, + { + "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", + "properties": { + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" + } + } + ] + } + } + }, + "operationId": "WorkspaceCertificate_ListByWorkspace", + "title": "ApiManagementListWorkspaceCertificates" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceDiagnostics.json new file mode 100644 index 000000000000..08702184667b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceDiagnostics.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "value": [ + { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 0 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 0 + }, + "headers": [] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 0 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 0 + }, + "headers": [] + } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" + }, + "verbosity": "information" + } + }, + { + "name": "azuremonitor", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/azuremonitor", + "properties": { + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/azuremonitor", + "sampling": { + "percentage": 100, + "samplingType": "fixed" + } + } + } + ] + } + } + }, + "operationId": "WorkspaceDiagnostic_ListByWorkspace", + "title": "ApiManagementListWorkspaceDiagnostics" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceGroupUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceGroupUsers.json new file mode 100644 index 000000000000..2dc7f465ded3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceGroupUsers.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "groupId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "armTemplateUser1", + "type": "Microsoft.ApiManagement/service/workspaces/groups/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/kjoshiarmTemplateUser1", + "properties": { + "email": "user1@live.com", + "firstName": "user1", + "identities": [ + { + "id": "user1@live.com", + "provider": "Basic" + } + ], + "lastName": "lastname1", + "note": "note for user 1", + "registrationDate": "2017-05-31T18:54:41.447Z", + "state": "active" + } + } + ] + } + } + }, + "operationId": "WorkspaceGroupUser_List", + "title": "ApiManagementListWorkspaceGroupUsers" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceGroups.json new file mode 100644 index 000000000000..ee68125107ad --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceGroups.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/59306a29e4bbd510dc24e5f9", + "properties": { + "type": "external", + "description": "awesome group of people", + "builtIn": false, + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + } + ] + } + } + }, + "operationId": "WorkspaceGroup_ListByService", + "title": "ApiManagementListWorkspaceGroups" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceLinks.json new file mode 100644 index 000000000000..da7e8dd6b55b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceLinks.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "service1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "wk-1", + "type": "Microsoft.ApiManagement/service/workspaceLinks", + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/service-1/workspaceLinks/wk-1", + "properties": { + "gateways": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/gateway-1" + } + ], + "workspaceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/service-1/workspaces/wk-1" + } + }, + { + "name": "wk-1", + "type": "Microsoft.ApiManagement/service/workspaceLinks", + "etag": "AAAAAAAWKwo=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/service-1/workspaceLinks/wk-2", + "properties": { + "gateways": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/gateway-1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/gateway-2" + } + ], + "workspaceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/service-1/workspaces/wk-2" + } + } + ] + } + } + }, + "operationId": "ApiManagementWorkspaceLinks_ListByService", + "title": "ApiManagementListGatewayConfigConnection" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceLoggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceLoggers.json new file mode 100644 index 000000000000..cfd4b9437ab7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceLoggers.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "azuremonitor", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/azuremonitor", + "properties": { + "isBuffered": true, + "loggerType": "azureMonitor" + } + }, + { + "name": "vvktest", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/vvktest", + "properties": { + "credentials": { + "instrumentationKey": "{{Logger-Credentials-5b1a17ef2b3f91153004b10d}}" + }, + "isBuffered": true, + "loggerType": "applicationInsights" + } + }, + { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/applicationinsights", + "properties": { + "description": "miaoappinsight", + "credentials": { + "instrumentationKey": "{{Logger-Credentials-5b2056062b3f911ae84a3069}}" + }, + "isBuffered": true, + "loggerType": "applicationInsights" + } + } + ] + } + } + }, + "operationId": "WorkspaceLogger_ListByWorkspace", + "title": "ApiManagementListWorkspaceLoggers" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceNamedValues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceNamedValues.json new file mode 100644 index 000000000000..9f2cddd78cce --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceNamedValues.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "592f1174cc83890dc4f32686", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/592f1174cc83890dc4f32686", + "properties": { + "displayName": "Logger-Credentials-592f1174cc83890dc4f32687", + "secret": false, + "value": "propValue" + } + }, + { + "name": "testprop6", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + }, + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" + }, + "secret": true, + "tags": [ + "foo", + "bar" + ] + } + } + ] + } + } + }, + "operationId": "WorkspaceNamedValue_ListByService", + "title": "ApiManagementListWorkspaceNamedValues" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceNotificationRecipientEmails.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceNotificationRecipientEmails.json new file mode 100644 index 000000000000..df2237f5036f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceNotificationRecipientEmails.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "contoso@live.com", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", + "properties": { + "email": "contoso@live.com" + } + }, + { + "name": "foobar!live", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", + "properties": { + "email": "foobar!live" + } + }, + { + "name": "foobar@live.com", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + ] + } + } + }, + "operationId": "WorkspaceNotificationRecipientEmail_ListByNotification", + "title": "ApiManagementListWorkspaceNotificationRecipientEmails" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceNotificationRecipientUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceNotificationRecipientUsers.json new file mode 100644 index 000000000000..7fa6573e0c96 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceNotificationRecipientUsers.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientUsers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + ] + } + } + }, + "operationId": "WorkspaceNotificationRecipientUser_ListByNotification", + "title": "ApiManagementListWorkspaceNotificationRecipientUsers" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceNotifications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceNotifications.json new file mode 100644 index 000000000000..9f607368102b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceNotifications.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/workspaces/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage", + "properties": { + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + }, + "title": "Subscription requests (requiring approval)" + } + }, + { + "name": "PurchasePublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/workspaces/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/PurchasePublisherNotificationMessage", + "properties": { + "description": "The following email recipients and users will receive email notifications about new API product subscriptions.", + "recipients": { + "emails": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com" + ], + "users": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + ] + }, + "title": "New subscriptions" + } + } + ] + } + } + }, + "operationId": "WorkspaceNotification_ListByService", + "title": "ApiManagementListWorkspaceNotifications" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspacePolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspacePolicies.json new file mode 100644 index 000000000000..57b94e3fc9b8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspacePolicies.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", + "properties": { + "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + ] + } + } + }, + "operationId": "WorkspacePolicy_ListByApi", + "title": "ApiManagementListWorkspacePolicies" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspacePolicyFragmentReferences.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspacePolicyFragmentReferences.json new file mode 100644 index 000000000000..d758a7665637 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspacePolicyFragmentReferences.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy" + } + ] + } + } + }, + "operationId": "WorkspacePolicyFragment_ListReferences", + "title": "ApiManagementListWorkspacePolicyFragmentReferences" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspacePolicyFragments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspacePolicyFragments.json new file mode 100644 index 000000000000..970cab78db74 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspacePolicyFragments.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", + "properties": { + "format": "xml", + "description": "A policy fragment example", + "value": "" + } + } + ] + } + } + }, + "operationId": "WorkspacePolicyFragment_ListByService", + "title": "ApiManagementListWorkspacePolicyFragments" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceProductApiLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceProductApiLinks.json new file mode 100644 index 000000000000..a5adec52359e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceProductApiLinks.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "product1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + ] + } + } + }, + "operationId": "WorkspaceProductApiLink_ListByProduct", + "title": "ApiManagementListWorkspaceProductApiLinks" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceProductGroupLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceProductGroupLinks.json new file mode 100644 index 000000000000..a88b0cc03c61 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceProductGroupLinks.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "product1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces.products/groupLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1/groupLinks/link1", + "properties": { + "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" + } + } + ] + } + } + }, + "operationId": "WorkspaceProductGroupLink_ListByProduct", + "title": "ApiManagementListWorkspaceProductGroupLinks" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceProductPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceProductPolicies.json new file mode 100644 index 000000000000..8379e2289930 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceProductPolicies.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "productId": "armTemplateProduct4", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/armTemplateProduct4/policies/policy", + "properties": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + ] + } + } + }, + "operationId": "WorkspaceProductPolicy_ListByProduct", + "title": "ApiManagementListWorkspaceProductPolicies" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceProducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceProducts.json new file mode 100644 index 000000000000..079895bc9f4a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceProducts.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "kjoshiarmtemplateCert1", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/kjoshiarmtemplateCert1", + "properties": { + "description": "Development Product", + "displayName": "Dev", + "state": "published", + "subscriptionRequired": false + } + }, + { + "name": "starter", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/starter", + "properties": { + "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", + "approvalRequired": false, + "displayName": "Starter", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1, + "terms": "" + } + }, + { + "name": "unlimited", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/unlimited", + "properties": { + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "approvalRequired": true, + "displayName": "Unlimited", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1 + } + } + ] + } + } + }, + "operationId": "WorkspaceProduct_ListByService", + "title": "ApiManagementListWorkspaceProducts" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceSchemas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceSchemas.json new file mode 100644 index 000000000000..8d26ae021c90 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceSchemas.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "schema1", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", + "properties": { + "description": "sample schema description", + "schemaType": "xml", + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + }, + { + "name": "schema2", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema2", + "properties": { + "description": "sample schema description", + "document": { + "type": "object", + "$id": "https://example.com/person.schema.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "properties": { + "age": { + "type": "integer", + "description": "Age in years which must be equal to or greater than zero.", + "minimum": 0 + }, + "firstName": { + "type": "string", + "description": "The person's first name." + }, + "lastName": { + "type": "string", + "description": "The person's last name." + } + }, + "title": "Person" + }, + "schemaType": "json" + } + } + ] + } + } + }, + "operationId": "WorkspaceGlobalSchema_ListByService", + "title": "ApiManagementListWorkspaceSchemas" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceSubscriptions.json new file mode 100644 index 000000000000..d1aa4e68aa80 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceSubscriptions.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 3, + "nextLink": "", + "value": [ + { + "name": "5600b59475ff190048070001", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/5600b59475ff190048070001", + "properties": { + "createdDate": "2015-09-22T01:57:40.3Z", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060001", + "state": "active" + } + }, + { + "name": "56eaed3dbaf08b06e46d27fe", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/56eaed3dbaf08b06e46d27fe", + "properties": { + "createdDate": "2016-03-17T17:45:33.837Z", + "displayName": "Starter", + "expirationDate": "2016-04-01T00:00:00Z", + "notificationDate": "2016-03-20T00:00:00Z", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060001", + "startDate": "2016-03-17T00:00:00Z", + "state": "active" + } + }, + { + "name": "5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/5931a769d8d14f0ad8ce13b8", + "properties": { + "createdDate": "2017-06-02T17:59:06.223Z", + "displayName": "Unlimited", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", + "state": "submitted" + } + } + ] + } + } + }, + "operationId": "WorkspaceSubscription_List", + "title": "ApiManagementListWorkspaceSubscriptions" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceTagApiLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceTagApiLinks.json new file mode 100644 index 000000000000..cdc48cd26480 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceTagApiLinks.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" + } + } + ] + } + } + }, + "operationId": "WorkspaceTagApiLink_ListByProduct", + "title": "ApiManagementListWorkspaceTagApiLinks" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceTagOperationLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceTagOperationLinks.json new file mode 100644 index 000000000000..8b4bd93a8584 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceTagOperationLinks.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", + "properties": { + "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" + } + } + ] + } + } + }, + "operationId": "WorkspaceTagOperationLink_ListByProduct", + "title": "ApiManagementListWorkspaceTagOperationLinks" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceTagProductLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceTagProductLinks.json new file mode 100644 index 000000000000..c23b3cc51abb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceTagProductLinks.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 1, + "nextLink": "", + "value": [ + { + "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", + "properties": { + "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" + } + } + ] + } + } + }, + "operationId": "WorkspaceTagProductLink_ListByProduct", + "title": "ApiManagementListWorkspaceTagProductLinks" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceTags.json new file mode 100644 index 000000000000..6fea841062c6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaceTags.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/5600b59375ff190048020001", + "properties": { + "displayName": "tag1" + } + }, + { + "name": "5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/5600b59375ff190048020002", + "properties": { + "displayName": "tag2" + } + } + ] + } + } + }, + "operationId": "WorkspaceTag_ListByService", + "title": "ApiManagementListWorkspaceTags" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaces.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaces.json new file mode 100644 index 000000000000..4ae65a289d1b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementListWorkspaces.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "count": 2, + "nextLink": "", + "value": [ + { + "name": "wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", + "properties": { + "description": "workspace 1", + "displayName": "my workspace" + } + }, + { + "name": "wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks2", + "properties": { + "description": "workspace 2", + "displayName": "my workspace" + } + } + ] + } + } + }, + "operationId": "Workspace_ListByService", + "title": "ApiManagementListWorkspaces" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementNamedValueListValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementNamedValueListValue.json new file mode 100644 index 000000000000..b9bffa813bbf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementNamedValueListValue.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "namedValueId": "testarmTemplateproperties2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": "propValue" + } + } + }, + "operationId": "NamedValue_ListValue", + "title": "ApiManagementNamedValueListValue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementOpenidConnectProviderListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementOpenidConnectProviderListSecrets.json new file mode 100644 index 000000000000..460f3d105afa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementOpenidConnectProviderListSecrets.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "opid": "templateOpenIdConnect2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "clientSecret": "oidsecretproviderTemplate2" + } + } + }, + "operationId": "OpenIdConnectProvider_ListSecrets", + "title": "ApiManagementOpenidConnectProviderListSecrets" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPerformConnectivityCheck.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPerformConnectivityCheck.json new file mode 100644 index 000000000000..563b9fa6c6fa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPerformConnectivityCheck.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "connectivityCheckRequestParams": { + "destination": { + "address": "8.8.8.8", + "port": 53 + }, + "preferredIPVersion": "IPv4", + "source": { + "region": "northeurope" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "avgLatencyInMs": 1, + "connectionStatus": "Connected", + "hops": [ + { + "type": "Source", + "address": "10.1.1.4", + "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "issues": [], + "nextHopIds": [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1" + }, + { + "type": "Internet", + "address": "8.8.8.8", + "id": "75c8d819-b208-4584-a311-1aa45ce753f9", + "issues": [], + "nextHopIds": [] + } + ], + "maxLatencyInMs": 4, + "minLatencyInMs": 1, + "probesFailed": 0, + "probesSent": 100 + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/connectivityCheck/operationresults/bmljb2xhLW5ldHdvcmt3YXRjaGVyNF9Db25uZWN0aXRpdml0eUNoZWNrXzE2MmExNmZl?api-version=2024-10-01-preview" + } + } + }, + "operationId": "PerformConnectivityCheckAsync", + "title": "TCP Connectivity Check" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPerformConnectivityCheckHttpConnect.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPerformConnectivityCheckHttpConnect.json new file mode 100644 index 000000000000..473b300d4ec9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPerformConnectivityCheckHttpConnect.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "connectivityCheckRequestParams": { + "destination": { + "address": "https://microsoft.com", + "port": 3306 + }, + "protocolConfiguration": { + "HTTPConfiguration": { + "method": "GET", + "headers": [ + { + "name": "Authorization", + "value": "Bearer myPreciousToken" + } + ], + "validStatusCodes": [ + 200, + 204 + ] + } + }, + "source": { + "region": "northeurope" + }, + "protocol": "HTTPS" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "avgLatencyInMs": 260, + "connectionStatus": "Reachable", + "hops": [ + { + "type": "Source", + "address": "20.82.216.48", + "id": "c60e2296-5ebc-48cc-80e8-7e6d2981e7b2", + "issues": [], + "nextHopIds": [ + "26aa44e7-04f1-462f-aa5d-5951957b5650" + ], + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1" + }, + { + "type": "Internet", + "address": "40.113.200.201", + "id": "26aa44e7-04f1-462f-aa5d-5951957b5650", + "issues": [], + "nextHopIds": [] + } + ], + "maxLatencyInMs": 281, + "minLatencyInMs": 250, + "probesFailed": 0, + "probesSent": 3 + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/connectivityCheck/operationresults/bmljb2xhLW5ldHdvcmt3YXRjaGVyNF9Db25uZWN0aXRpdml0eUNoZWNrXzE2MmExNmZl?api-version=2024-10-01-preview" + } + } + }, + "operationId": "PerformConnectivityCheckAsync", + "title": "HTTP Connectivity Check" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalConfig.json new file mode 100644 index 000000000000..1e296dceb7f1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalConfig.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "portalConfigId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.ApiManagement/service/portalconfigs", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", + "properties": { + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] + }, + "csp": { + "allowedSources": [ + "*.contoso.com" + ], + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ] + }, + "delegation": { + "delegateRegistration": false, + "delegateSubscription": false, + "delegationUrl": null, + "validationKey": null + }, + "enableBasicAuth": true, + "signin": { + "require": false + }, + "signup": { + "termsOfService": { + "requireConsent": false, + "text": "I agree to the service terms and conditions." + } + } + } + } + } + }, + "operationId": "PortalConfig_Get", + "title": "ApiManagementPortalConfig" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsGetDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsGetDelegation.json new file mode 100644 index 000000000000..45d9895ccd2c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsGetDelegation.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "delegation", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation", + "properties": { + "subscriptions": { + "enabled": true + }, + "url": "http://contoso.com/delegation", + "userRegistration": { + "enabled": true + } + } + } + } + }, + "operationId": "DelegationSettings_Get", + "title": "ApiManagementPortalSettingsGetDelegation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsGetSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsGetSignIn.json new file mode 100644 index 000000000000..2239bf53e4eb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsGetSignIn.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "signin", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin", + "properties": { + "enabled": true + } + } + } + }, + "operationId": "SignInSettings_Get", + "title": "ApiManagementPortalSettingsGetSignIn" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsGetSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsGetSignUp.json new file mode 100644 index 000000000000..525c73612beb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsGetSignUp.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "signup", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup", + "properties": { + "enabled": true, + "termsOfService": { + "consentRequired": true, + "enabled": true, + "text": "Terms of service text." + } + } + } + } + }, + "operationId": "SignUpSettings_Get", + "title": "ApiManagementPortalSettingsGetSignUp" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsPutDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsPutDelegation.json new file mode 100644 index 000000000000..b7dc44bcf22a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsPutDelegation.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "subscriptions": { + "enabled": true + }, + "url": "http://contoso.com/delegation", + "userRegistration": { + "enabled": true + }, + "validationKey": "" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" + }, + "responses": { + "200": { + "body": { + "name": "delegation", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation", + "properties": { + "subscriptions": { + "enabled": true + }, + "url": "http://contoso.com/delegation", + "userRegistration": { + "enabled": true + } + } + } + } + }, + "operationId": "DelegationSettings_CreateOrUpdate", + "title": "ApiManagementPortalSettingsUpdateDelegation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsPutSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsPutSignIn.json new file mode 100644 index 000000000000..2b351fd10c85 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsPutSignIn.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "enabled": true + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" + }, + "responses": { + "200": { + "body": { + "name": "signin", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin", + "properties": { + "enabled": true + } + } + } + }, + "operationId": "SignInSettings_CreateOrUpdate", + "title": "ApiManagementPortalSettingsUpdateSignIn" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsPutSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsPutSignUp.json new file mode 100644 index 000000000000..db1349327dee --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsPutSignUp.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "enabled": true, + "termsOfService": { + "consentRequired": true, + "enabled": true, + "text": "Terms of service text." + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" + }, + "responses": { + "200": { + "body": { + "name": "signup", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup", + "properties": { + "enabled": true, + "termsOfService": { + "consentRequired": true, + "enabled": true, + "text": "Terms of service text." + } + } + } + } + }, + "operationId": "SignUpSettings_CreateOrUpdate", + "title": "ApiManagementPortalSettingsUpdateSignUp" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsUpdateDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsUpdateDelegation.json new file mode 100644 index 000000000000..47313a438e17 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsUpdateDelegation.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "subscriptions": { + "enabled": true + }, + "url": "http://contoso.com/delegation", + "userRegistration": { + "enabled": true + }, + "validationKey": "" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" + }, + "responses": { + "204": {} + }, + "operationId": "DelegationSettings_Update", + "title": "ApiManagementPortalSettingsUpdateDelegation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsUpdateSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsUpdateSignIn.json new file mode 100644 index 000000000000..709f28e1dadb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsUpdateSignIn.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "enabled": true + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" + }, + "responses": { + "204": {} + }, + "operationId": "SignInSettings_Update", + "title": "ApiManagementPortalSettingsUpdateSignIn" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsUpdateSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsUpdateSignUp.json new file mode 100644 index 000000000000..26f2a8458663 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPortalSettingsUpdateSignUp.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "enabled": true, + "termsOfService": { + "consentRequired": true, + "enabled": true, + "text": "Terms of service text." + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" + }, + "responses": { + "204": {} + }, + "operationId": "SignUpSettings_Update", + "title": "ApiManagementPortalSettingsUpdateSignUp" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPostAuthorizationConfirmConsentCodeRequest.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPostAuthorizationConfirmConsentCodeRequest.json new file mode 100644 index 000000000000..0697deb1d555 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementPostAuthorizationConfirmConsentCodeRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "authorizationId": "authz1", + "authorizationProviderId": "aadwithauthcode", + "parameters": { + "consentCode": "theconsentcode" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {} + }, + "operationId": "Authorization_ConfirmConsentCode", + "title": "ApiManagementPostAuthorizationConfirmConsentCodeRequest" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRefreshCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRefreshCertificate.json new file mode 100644 index 000000000000..9c9a97fa3740 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRefreshCertificate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "templateCertkv", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", + "properties": { + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" + } + } + } + }, + "operationId": "Certificate_RefreshSecret", + "title": "ApiManagementRefreshCertificate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRefreshNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRefreshNamedValue.json new file mode 100644 index 000000000000..c2677fbe6392 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRefreshNamedValue.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "namedValueId": "testprop2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert" + }, + "secret": true, + "tags": [ + "foo", + "bar" + ] + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6/refreshSecret?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "NamedValue_RefreshSecret", + "title": "ApiManagementRefreshNamedValue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRefreshWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRefreshWorkspaceCertificate.json new file mode 100644 index 000000000000..c97a4c6c5199 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRefreshWorkspaceCertificate.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "certificateId": "templateCertkv", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", + "properties": { + "expirationDate": "2037-01-01T07:00:00Z", + "keyVault": { + "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-22T00:24:53.3191468Z" + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" + } + } + } + }, + "operationId": "WorkspaceCertificate_RefreshSecret", + "title": "ApiManagementRefreshWorkspaceCertificate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRefreshWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRefreshWorkspaceNamedValue.json new file mode 100644 index 000000000000..c516f443cd1d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRefreshWorkspaceNamedValue.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "namedValueId": "testprop2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "testprop6", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", + "properties": { + "displayName": "prop6namekv", + "keyVault": { + "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", + "lastStatus": { + "code": "Success", + "timeStampUtc": "2020-09-11T00:54:31.8024882Z" + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert" + }, + "secret": true, + "tags": [ + "foo", + "bar" + ] + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6/refreshSecret?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + } + }, + "operationId": "WorkspaceNamedValue_RefreshSecret", + "title": "ApiManagementRefreshWorkspaceNamedValue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRestoreWithAccessKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRestoreWithAccessKey.json new file mode 100644 index 000000000000..974f789dadec --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementRestoreWithAccessKey.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "accessKey": "**************************************************", + "accessType": "AccessKey", + "backupName": "apimService1backup_2017_03_19", + "containerName": "backupContainer", + "storageAccount": "teststorageaccount" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAACXok=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "West US", + "properties": { + "additionalLocations": [ + { + "disableGateway": true, + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "location": "East US", + "publicIPAddresses": [ + "23.101.138.153" + ], + "sku": { + "name": "Premium", + "capacity": 1 + } + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, + "createdAtUtc": "2019-12-18T06:26:20.3348609Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "defaultSslBinding": false, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + }, + { + "type": "Proxy", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" + }, + "defaultSslBinding": true, + "hostName": "gateway1.msitesting.net", + "negotiateClientCertificate": false + }, + { + "type": "Management", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" + }, + "defaultSslBinding": false, + "hostName": "mgmt.msitesting.net", + "negotiateClientCertificate": false + }, + { + "type": "Portal", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" + }, + "defaultSslBinding": false, + "hostName": "portal1.msitesting.net", + "negotiateClientCertificate": false + }, + { + "type": "ConfigurationApi", + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" + }, + "defaultSslBinding": false, + "hostName": "config-api.msitesting.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.91.32.113" + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" + } + } + }, + "operationId": "ApiManagementService_Restore", + "title": "ApiManagementRestoreService" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceCheckNameAvailability.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceCheckNameAvailability.json new file mode 100644 index 000000000000..eff793d34f0e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceCheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "name": "apimService1" + }, + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "message": "", + "nameAvailable": true, + "reason": "Valid" + } + } + }, + "operationId": "ApiManagementService_CheckNameAvailability", + "title": "ApiManagementServiceCheckNameAvailability" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceDeleteService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceDeleteService.json new file mode 100644 index 000000000000..970c088ca22b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceDeleteService.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "202": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAFfhHY=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "West US", + "properties": { + "createdAtUtc": "2016-12-20T19:41:21.5823069Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True" + }, + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "40.XX.XXX.168" + ], + "publisherEmail": "contoso@live.com", + "publisherName": "Microsoft", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "Deleting", + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/BlockVNETSamir/subnets/default" + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "Developer", + "capacity": 1 + }, + "tags": {} + }, + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2024-10-01-preview" + } + }, + "204": {} + }, + "operationId": "ApiManagementService_Delete", + "title": "ApiManagementServiceDeleteService" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetDomainOwnershipIdentifier.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetDomainOwnershipIdentifier.json new file mode 100644 index 000000000000..885296543a26 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetDomainOwnershipIdentifier.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "domainOwnershipIdentifier": "KLE1vdMblVeHECAi4nCe3oNaXXXXvNlLrXt2ev84KM=" + } + } + }, + "operationId": "ApiManagementService_GetDomainOwnershipIdentifier", + "title": "ApiManagementServiceGetDomainOwnershipIdentifier" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetMultiRegionInternalVnet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetMultiRegionInternalVnet.json new file mode 100644 index 000000000000..471488800f2e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetMultiRegionInternalVnet.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimservice1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAADqC0c=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1", + "location": "West US", + "properties": { + "additionalLocations": [ + { + "disableGateway": false, + "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net", + "location": "West US 2", + "privateIPAddresses": [ + "10.0.X.6" + ], + "publicIPAddresses": [ + "40.XXX.79.187" + ], + "sku": { + "name": "Premium", + "capacity": 1 + }, + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub" + } + } + ], + "apiVersionConstraint": {}, + "createdAtUtc": "2019-12-02T01:42:09.1268424Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net", + "gatewayUrl": "https://apimservice1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": false, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + }, + { + "type": "Proxy", + "certificate": { + "expiry": "2019-08-16T16:51:34+00:00", + "subject": "CN=*.preview.net", + "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476" + }, + "certificateSource": "Custom", + "defaultSslBinding": true, + "hostName": "apimgatewaytest.preview.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimservice1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimservice1.portal.azure-api.net", + "privateIPAddresses": [ + "172.XX.0.5" + ], + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "137.XXX.11.74" + ], + "publisherEmail": "abcs@contoso.com", + "publisherName": "contoso publisher", + "scmUrl": "https://apimservice1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet" + }, + "virtualNetworkType": "Internal" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "tags": {} + } + } + }, + "operationId": "ApiManagementService_Get", + "title": "ApiManagementServiceGetMultiRegionInternalVnet" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetNetworkStatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetNetworkStatus.json new file mode 100644 index 000000000000..5da2ccdc17ea --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetNetworkStatus.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": [ + { + "location": "Central US EUAP", + "networkStatus": { + "connectivityStatus": [ + { + "name": "apimst8rlxXXXXX7.queue.core.windows.net", + "error": "", + "isOptional": true, + "lastStatusChange": "2023-05-25T03:53:44.1786214Z", + "lastUpdated": "2023-06-08T16:41:44.6399168Z", + "resourceType": "SmtpQueue", + "status": "success" + }, + { + "name": "apimstm5lkXXXXX4kky0.blob.core.windows.net", + "error": "", + "isOptional": false, + "lastStatusChange": "2023-05-25T03:53:44.1786214Z", + "lastUpdated": "2023-06-08T16:39:33.9426753Z", + "resourceType": "BlobStorage", + "status": "success" + }, + { + "name": "apimstm5lkXXXXX4kky0.file.core.windows.net", + "error": "", + "isOptional": true, + "lastStatusChange": "2023-05-25T03:53:43.8953621Z", + "lastUpdated": "2023-06-08T16:41:38.9993574Z", + "resourceType": "FileStorage", + "status": "success" + }, + { + "name": "apimstm5lkXXXXX4kky0.queue.core.windows.net", + "error": "", + "isOptional": true, + "lastStatusChange": "2023-05-25T03:53:44.2081238Z", + "lastUpdated": "2023-06-08T16:41:38.4368875Z", + "resourceType": "Queue", + "status": "success" + }, + { + "name": "apimstm5lkXXXXX4kky0.table.core.windows.net", + "error": "", + "isOptional": false, + "lastStatusChange": "2023-05-25T03:53:43.9734877Z", + "lastUpdated": "2023-06-08T16:41:17.4762359Z", + "resourceType": "TableStorage", + "status": "success" + }, + { + "name": "apirpsqlmgsXXXXXXic45.database.windows.net", + "error": "", + "isOptional": false, + "lastStatusChange": "2023-05-25T03:53:44.0704109Z", + "lastUpdated": "2023-06-08T16:40:50.2954792Z", + "resourceType": "SQLDatabase", + "status": "success" + }, + { + "name": "gcs.prod.monitoring.core.windows.net", + "error": "", + "isOptional": false, + "lastStatusChange": "2023-05-25T03:53:43.8484895Z", + "lastUpdated": "2023-06-08T16:40:09.8448385Z", + "resourceType": "Monitoring", + "status": "success" + }, + { + "name": "https://apikv-XXXXXXurugl3.vault.azure.net", + "error": "", + "isOptional": false, + "lastStatusChange": "2023-06-02T06:54:45.7125288Z", + "lastUpdated": "2023-06-08T16:40:17.3447288Z", + "resourceType": "AzureKeyVault", + "status": "success" + }, + { + "name": "https://centraluseuap.login.microsoft.com", + "error": "", + "isOptional": true, + "lastStatusChange": "2023-05-25T03:53:44.1490292Z", + "lastUpdated": "2023-06-08T16:40:01.6660359Z", + "resourceType": "RegionalAzureActiveDirectory", + "status": "success" + }, + { + "name": "https://gcs.prod.warm.ingestion.monitoring.azure.com", + "error": "", + "isOptional": true, + "lastStatusChange": "2023-05-26T14:09:26.2508948Z", + "lastUpdated": "2023-06-08T16:42:08.0050056Z", + "resourceType": "Monitoring", + "status": "success" + }, + { + "name": "https://global.prod.microsoftmetrics.com/", + "error": "", + "isOptional": true, + "lastStatusChange": "2023-05-25T03:53:44.1297766Z", + "lastUpdated": "2023-06-08T16:40:12.9698299Z", + "resourceType": "Monitoring", + "status": "success" + }, + { + "name": "https://login.windows.net", + "error": "", + "isOptional": true, + "lastStatusChange": "2023-06-04T11:10:16.1041673Z", + "lastUpdated": "2023-06-08T16:40:43.4048644Z", + "resourceType": "AzureActiveDirectory", + "status": "success" + }, + { + "name": "https://partner.prod.repmap.microsoft.com", + "error": "", + "isOptional": true, + "lastStatusChange": "2023-05-25T03:53:44.2081238Z", + "lastUpdated": "2023-06-08T16:40:32.6067213Z", + "resourceType": "CaptchaEndpoint", + "status": "success" + }, + { + "name": "https://xxxxx.prod.microsoftmetrics.com:1886/RecoveryService", + "error": "", + "isOptional": true, + "lastStatusChange": "2023-05-25T03:53:44.3488261Z", + "lastUpdated": "2023-06-08T16:42:33.8566303Z", + "resourceType": "Metrics", + "status": "success" + }, + { + "name": "https://samir-XXXXXXX.management.azure-api.net:3443/servicestatus?api-version=2018-01-01", + "error": "", + "isOptional": false, + "lastStatusChange": "2023-06-08T16:42:10.3954682Z", + "lastUpdated": "2023-06-08T16:42:10.3954682Z", + "resourceType": "ApiManagement Control Plane - inbound", + "status": "success" + }, + { + "name": "LocalGatewayRedis", + "error": "", + "isOptional": true, + "lastStatusChange": "2023-05-25T03:53:44.2081238Z", + "lastUpdated": "2023-06-08T16:39:30.184537Z", + "resourceType": "InternalCache", + "status": "success" + }, + { + "name": "Scm", + "error": "", + "isOptional": true, + "lastStatusChange": "2023-05-25T03:32:02.6480516Z", + "lastUpdated": "2023-06-08T16:41:24.6623693Z", + "resourceType": "SourceControl", + "status": "success" + } + ], + "dnsServers": [ + "168.63.129.16" + ] + } + } + ] + } + }, + "operationId": "NetworkStatus_ListByService", + "title": "ApiManagementServiceGetNetworkStatus" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetNetworkStatusByLocation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetNetworkStatusByLocation.json new file mode 100644 index 000000000000..52909268182d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetNetworkStatusByLocation.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "locationName": "North Central US", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "connectivityStatus": [ + { + "name": "apimgmtst6tnxxxxxxxxxxx.blob.core.windows.net", + "error": "", + "isOptional": false, + "lastStatusChange": "2020-11-20T07:54:55.9365931Z", + "lastUpdated": "2020-11-24T22:55:14.7035899Z", + "resourceType": "BlobStorage", + "status": "success" + }, + { + "name": "apimgmtst6tnxxxxxxxxxxx.file.core.windows.net", + "error": "", + "isOptional": true, + "lastStatusChange": "2020-11-20T07:54:55.9265938Z", + "lastUpdated": "2020-11-24T22:55:41.5322463Z", + "resourceType": "FileStorage", + "status": "success" + }, + { + "name": "apimgmtst6tnxxxxxxxxxxx.queue.core.windows.net", + "error": "", + "isOptional": true, + "lastStatusChange": "2020-11-20T07:54:55.8410477Z", + "lastUpdated": "2020-11-24T22:55:30.645994Z", + "resourceType": "Queue", + "status": "success" + }, + { + "name": "apimgmtst6tnxxxxxxxxxxx.table.core.windows.net", + "error": "", + "isOptional": false, + "lastStatusChange": "2020-11-20T07:54:55.9365931Z", + "lastUpdated": "2020-11-24T22:55:23.8789171Z", + "resourceType": "TableStorage", + "status": "success" + }, + { + "name": "gcs.prod.monitoring.core.windows.net", + "error": "", + "isOptional": true, + "lastStatusChange": "2020-11-20T08:07:37.5486932Z", + "lastUpdated": "2020-11-24T22:57:34.8666833Z", + "resourceType": "Monitoring", + "status": "success" + }, + { + "name": "https://gcs.ppe.warm.ingestion.monitoring.azure.com", + "error": "", + "isOptional": true, + "lastStatusChange": "2020-11-20T07:54:56.1060523Z", + "lastUpdated": "2020-11-24T22:56:26.1870188Z", + "resourceType": "Monitoring", + "status": "success" + }, + { + "name": "https://global.metrics.nsatc.net/", + "error": "", + "isOptional": true, + "lastStatusChange": "2020-11-20T07:54:56.0510519Z", + "lastUpdated": "2020-11-24T22:56:35.9620612Z", + "resourceType": "Monitoring", + "status": "success" + }, + { + "name": "https://login.windows.net", + "error": "", + "isOptional": true, + "lastStatusChange": "2020-11-20T07:54:56.1060523Z", + "lastUpdated": "2020-11-24T22:56:30.8047708Z", + "resourceType": "AzureActiveDirectory", + "status": "success" + }, + { + "name": "https://prod2.metrics.nsatc.net:1886/RecoveryService", + "error": "", + "isOptional": true, + "lastStatusChange": "2020-11-20T07:54:56.2796235Z", + "lastUpdated": "2020-11-24T22:56:45.2095302Z", + "resourceType": "Metrics", + "status": "success" + }, + { + "name": "LocalGatewayRedis", + "error": "", + "isOptional": true, + "lastStatusChange": "2020-11-20T07:54:55.9365931Z", + "lastUpdated": "2020-11-24T22:55:15.1345836Z", + "resourceType": "InternalCache", + "status": "success" + }, + { + "name": "prod.warmpath.msftcloudes.com", + "error": "", + "isOptional": false, + "lastStatusChange": "2020-11-20T07:54:55.8410477Z", + "lastUpdated": "2020-11-24T22:55:57.8992141Z", + "resourceType": "Monitoring", + "status": "success" + }, + { + "name": "Scm", + "error": "", + "isOptional": true, + "lastStatusChange": "2020-11-20T07:54:57.325384Z", + "lastUpdated": "2020-11-24T23:03:57.6187917Z", + "resourceType": "SourceControl", + "status": "success" + }, + { + "name": "smtpi-xxx.msn.com:25028", + "error": "", + "isOptional": true, + "lastStatusChange": "2020-11-20T07:54:56.3510577Z", + "lastUpdated": "2020-11-24T22:58:22.2430074Z", + "resourceType": "Email", + "status": "success" + }, + { + "name": "zwcvuxxxx.database.windows.net", + "error": "", + "isOptional": false, + "lastStatusChange": "2020-11-20T07:54:56.0410467Z", + "lastUpdated": "2020-11-24T22:55:44.3582171Z", + "resourceType": "SQLDatabase", + "status": "success" + } + ], + "dnsServers": [ + "10.82.98.10" + ] + } + } + }, + "operationId": "NetworkStatus_ListByLocation", + "title": "ApiManagementServiceGetNetworkStatusByLocation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..628c18068877 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,465 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "Azure SMTP", + "endpoints": [ + { + "domainName": "smtpi-ch1.msn.com", + "endpointDetails": [ + { + "port": 25028, + "region": "West US" + } + ] + } + ] + }, + { + "category": "Azure SQL", + "endpoints": [ + { + "domainName": "xxxx1345234.database.windows.net", + "endpointDetails": [ + { + "port": 1433, + "region": "West US" + } + ] + } + ] + }, + { + "category": "Azure Storage", + "endpoints": [ + { + "domainName": "xxxx32storagedgfbay.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx1362629927xt.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx1362629927xt.table.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx141483183xt.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx141483183xt.table.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx1949864718xt.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx1949864718xt.table.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx3292114122xt.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx3292114122xt.table.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx32tst4oto8t0mlesawmm.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx32tst4oto8t0mlesawmm.file.core.windows.net", + "endpointDetails": [ + { + "port": 445, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx32tst4oto8t0mlesawmm.queue.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx32tst4oto8t0mlesawmm.table.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + } + ] + } + ] + }, + { + "category": "Azure Event Hub", + "endpoints": [ + { + "domainName": "xxxx1362629927eh.servicebus.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + }, + { + "port": 5671, + "region": "West US" + }, + { + "port": 5672, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx1949864718eh.servicebus.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + }, + { + "port": 5671, + "region": "West US" + }, + { + "port": 5672, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx3292114122eh.servicebus.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + }, + { + "port": 5671, + "region": "West US" + }, + { + "port": 5672, + "region": "West US" + } + ] + }, + { + "domainName": "xxxx141483183eh.servicebus.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "West US" + }, + { + "port": 5671, + "region": "West US" + }, + { + "port": 5672, + "region": "West US" + } + ] + } + ] + }, + { + "category": "SSL Certificate Verification", + "endpoints": [ + { + "domainName": "ocsp.msocsp.com", + "endpointDetails": [ + { + "port": 80, + "region": "Global" + }, + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "mscrl.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "region": "Global" + }, + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "crl.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "region": "Global" + }, + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "crl3.digicert.com", + "endpointDetails": [ + { + "port": 80, + "region": "Global" + }, + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "ocsp.digicert.com", + "endpointDetails": [ + { + "port": 80, + "region": "Global" + }, + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "cacerts.digicert.com", + "endpointDetails": [ + { + "port": 80, + "region": "Global" + }, + { + "port": 443, + "region": "Global" + } + ] + } + ] + }, + { + "category": "Azure Monitor", + "endpoints": [ + { + "domainName": "gcs.ppe.monitoring.core.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "global.prod.microsoftmetrics.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "xxx3.prod.microsoftmetrics.com", + "endpointDetails": [ + { + "port": 1886, + "region": "Global" + } + ] + }, + { + "domainName": "xxx3-red.prod.microsoftmetrics.com", + "endpointDetails": [ + { + "port": 1886, + "region": "Global" + } + ] + }, + { + "domainName": "xxx3-black.prod.microsoftmetrics.com", + "endpointDetails": [ + { + "port": 1886, + "region": "Global" + } + ] + }, + { + "domainName": "gcs.ppe.warm.ingestion.monitoring.azure.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "metrichost23.prod.microsoftmetrics.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "metrichost23-red.prod.microsoftmetrics.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "metrichost23-black.prod.microsoftmetrics.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + } + ] + }, + { + "category": "Portal Captcha", + "endpoints": [ + { + "domainName": "client.xxx.live.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "partner.xxx.live.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + } + ] + }, + { + "category": "Azure Active Directory", + "endpoints": [ + { + "domainName": "login.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "graph.windows.net", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + }, + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443, + "region": "Global" + } + ] + } + ] + } + ] + } + } + }, + "operationId": "OutboundNetworkDependenciesEndpoints_ListByService", + "title": "ApiManagementServiceGetOutboundNetworkDependenciesEndpoints" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetService.json new file mode 100644 index 000000000000..fb765b66b1f0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetService.json @@ -0,0 +1,181 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "OGF-Z3-06162021-Premium", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789", + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d" + } + } + }, + "location": "East US", + "properties": { + "additionalLocations": [ + { + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net", + "location": "East US 2", + "platformVersion": "stv2", + "publicIPAddresses": [ + "40.70.24.106" + ], + "sku": { + "name": "Premium", + "capacity": 1 + }, + "zones": [] + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "certificates": [], + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false" + }, + "developerPortalUrl": "https://ogf-z3-06162021-premium.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": false, + "hostName": "ogf-z3-06162021-premium.azure-api.net", + "negotiateClientCertificate": false + }, + { + "type": "Proxy", + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51" + }, + "certificateSource": "Custom", + "defaultSslBinding": true, + "hostName": "gateway.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", + "negotiateClientCertificate": true + }, + { + "type": "DeveloperPortal", + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51" + }, + "certificateSource": "Custom", + "defaultSslBinding": false, + "hostName": "developer.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", + "negotiateClientCertificate": false + }, + { + "type": "Management", + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51" + }, + "certificateSource": "Custom", + "defaultSslBinding": false, + "hostName": "mgmt.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", + "negotiateClientCertificate": false + }, + { + "type": "ConfigurationApi", + "certificate": { + "expiry": "2022-01-08T22:32:32+00:00", + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51" + }, + "certificateSource": "Custom", + "defaultSslBinding": false, + "hostName": "configuration-api.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net", + "privateEndpointConnections": [ + { + "name": "privateEndpointProxyName", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName", + "properties": { + "groupIds": [ + "Gateway" + ], + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "description": "Please approve my request, thanks", + "actionsRequired": "None", + "status": "Pending" + }, + "provisioningState": "Pending" + } + } + ], + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.92.130.49" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "string", + "publisherName": "Test Premium", + "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "systemData": { + "createdAt": "2021-06-16T09:40:00.7106733Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z", + "lastModifiedBy": "foo@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "ReleaseName": "Z3", + "owner": "v-aswmoh" + } + } + } + }, + "operationId": "ApiManagementService_Get", + "title": "ApiManagementServiceGetService" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetServiceHavingMsi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetServiceHavingMsi.json new file mode 100644 index 000000000000..24079e30f486 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetServiceHavingMsi.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAENfI=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "ca1d33f7-0000-42ec-0000-d526a1ee953a", + "tenantId": "72f988bf-0000-41af-0000-2d7cd011db47", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": { + "clientId": "aaff9c7d-0000-4db2-0000-ab0e3e7806cf", + "principalId": "95194df2-9208-0000-0000-a10d2af9b5a3" + } + } + }, + "location": "West Europe", + "properties": { + "createdAtUtc": "2016-04-12T00:20:15.6018952Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": false, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + }, + { + "type": "Proxy", + "certificate": { + "expiry": "2020-12-18T11:11:47+00:00", + "subject": "CN=*.msitesting.net", + "thumbprint": "9833D531D7A45XXXXXA85908BD3692E0BD3F" + }, + "certificateSource": "KeyVault", + "defaultSslBinding": true, + "hostName": "proxy.msitesting.net", + "keyVaultId": "https://samir-msi-keyvault.vault.azure.net/secrets/msicertificate", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.94.xxx.188" + ], + "publisherEmail": "foo@contoso.com", + "publisherName": "Contoso", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet" + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "tags": {} + } + } + }, + "operationId": "ApiManagementService_Get", + "title": "ApiManagementServiceGetServiceHavingMsi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetSsoToken.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetSsoToken.json new file mode 100644 index 000000000000..fa54afac75c7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceGetSsoToken.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "redirectUri": "https://apimService1.portal.azure-api.net:443/signin-sso?token=1%26201705301929%26eIkr3%2fnfaLs1GVJ0OVbzkJjAcwPFkEZAPM8VUXvXPf7cJ6lWsB9oUwsk2zln9x0KLkn21txCPJWWheSPq7SNeA%3d%3d" + } + } + }, + "operationId": "ApiManagementService_GetSsoToken", + "title": "ApiManagementServiceGetSsoToken" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceMigrateToStv2.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceMigrateToStv2.json new file mode 100644 index 000000000000..9a251cbff63c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementServiceMigrateToStv2.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "mode": "PreserveIp" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimservice1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAADqC0c=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1", + "location": "West US", + "properties": { + "additionalLocations": [ + { + "disableGateway": false, + "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net", + "location": "West US 2", + "privateIPAddresses": [ + "10.0.X.6" + ], + "publicIPAddresses": [ + "40.XXX.79.187" + ], + "sku": { + "name": "Premium", + "capacity": 1 + }, + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub" + } + } + ], + "apiVersionConstraint": {}, + "createdAtUtc": "2019-12-02T01:42:09.1268424Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net", + "gatewayUrl": "https://apimservice1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": false, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + }, + { + "type": "Proxy", + "certificate": { + "expiry": "2019-08-16T16:51:34+00:00", + "subject": "CN=*.preview.net", + "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476" + }, + "certificateSource": "Custom", + "defaultSslBinding": true, + "hostName": "apimgatewaytest.preview.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimservice1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "portalUrl": "https://apimservice1.portal.azure-api.net", + "privateIPAddresses": [ + "172.XX.0.5" + ], + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "137.XXX.11.74" + ], + "publisherEmail": "abcs@contoso.com", + "publisherName": "contoso publisher", + "scmUrl": "https://apimservice1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet" + }, + "virtualNetworkType": "Internal" + }, + "sku": { + "name": "Premium", + "capacity": 1 + }, + "tags": {} + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" + } + } + }, + "operationId": "ApiManagementService_MigrateToStv2", + "title": "ApiManagementMigrateService" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementSubscriptionListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementSubscriptionListSecrets.json new file mode 100644 index 000000000000..44ae70b5fbe3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementSubscriptionListSecrets.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "5931a769d8d14f0ad8ce13b8", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + }, + "operationId": "Subscription_ListSecrets", + "title": "ApiManagementSubscriptionListSecrets" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementSubscriptionRegeneratePrimaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementSubscriptionRegeneratePrimaryKey.json new file mode 100644 index 000000000000..6002ad53882e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementSubscriptionRegeneratePrimaryKey.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + }, + "operationId": "Subscription_RegeneratePrimaryKey", + "title": "ApiManagementSubscriptionRegeneratePrimaryKey" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementSubscriptionRegenerateSecondaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementSubscriptionRegenerateSecondaryKey.json new file mode 100644 index 000000000000..0c7fad53c6bd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementSubscriptionRegenerateSecondaryKey.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + }, + "operationId": "Subscription_RegenerateSecondaryKey", + "title": "ApiManagementSubscriptionRegenerateSecondaryKey" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessGitRegenerateSecondaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessGitRegenerateSecondaryKey.json new file mode 100644 index 000000000000..2b29b649cc70 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessGitRegenerateSecondaryKey.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accessName": "access", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + }, + "operationId": "TenantAccessGit_RegenerateSecondaryKey", + "title": "ApiManagementTenantAccessRegenerateKey" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessRegenerateKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessRegenerateKey.json new file mode 100644 index 000000000000..385ac71e37f8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessRegenerateKey.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accessName": "access", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + }, + "operationId": "TenantAccess_RegenerateSecondaryKey", + "title": "ApiManagementTenantAccessRegenerateKey" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessRegeneratePrimaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessRegeneratePrimaryKey.json new file mode 100644 index 000000000000..7c4c6a5964bd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessRegeneratePrimaryKey.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accessName": "access", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + }, + "operationId": "TenantAccess_RegeneratePrimaryKey", + "title": "ApiManagementTenantAccessRegenerateKey" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessRegenerateSecondaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessRegenerateSecondaryKey.json new file mode 100644 index 000000000000..32ad02923bd5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessRegenerateSecondaryKey.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accessName": "access", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + }, + "operationId": "TenantAccessGit_RegeneratePrimaryKey", + "title": "ApiManagementTenantAccessRegenerateKey" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessSyncState.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessSyncState.json new file mode 100644 index 000000000000..072fa158cef7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantAccessSyncState.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "configurationName": "configuration", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "syncState", + "type": "Microsoft.ApiManagement/service/tenant/syncState", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/tenant/configuration", + "properties": { + "branch": "master", + "commitId": "de891c2342c7058dde45e5e624eae7e558c94683", + "configurationChangeDate": "2021-04-13T00:11:43.862781Z", + "isExport": true, + "isGitEnabled": true, + "isSynced": true, + "lastOperationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/operationResults/6074f0bd093a9d0dac3d7347", + "syncDate": "2021-04-13T01:15:53.9824995Z" + } + } + } + }, + "operationId": "TenantConfiguration_GetSyncState", + "title": "ApiManagementTenantAccessSyncState" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantConfigurationDeploy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantConfigurationDeploy.json new file mode 100644 index 000000000000..79df9163579d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantConfigurationDeploy.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "configurationName": "configuration", + "parameters": { + "properties": { + "branch": "master" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "6074e652093a9d0dac3d733c", + "type": "Microsoft.ApiManagement/service/tenant/operationResults", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/tenant/configuration", + "properties": { + "error": { + "code": "ValidationError", + "message": "File not found: 'api-management/configuration.json'" + }, + "started": "2017-11-26T17:06:54.303Z", + "status": "Failed", + "updated": "2017-11-26T17:07:21.777Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af4ae2a6d2e0b688d7517?api-version=2024-10-01-preview" + } + } + }, + "operationId": "TenantConfiguration_Deploy", + "title": "ApiManagementTenantConfigurationDeploy" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantConfigurationSave.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantConfigurationSave.json new file mode 100644 index 000000000000..361cfc441a9d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantConfigurationSave.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "configurationName": "configuration", + "parameters": { + "properties": { + "branch": "master" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "6074e652093a9d0dac3d733c", + "type": "Microsoft.ApiManagement/service/tenant/operationResults", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/tenant/configuration", + "properties": { + "actionLog": [], + "resultInfo": "The configuration was successfully saved to master as commit c0ae274f6046912107bad734834cbf65918668b6.", + "started": "2021-04-13T00:31:14.94Z", + "status": "Succeeded", + "updated": "2021-04-13T00:31:27.59Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af57d2a6d2e0b688d751b?api-version=2024-10-01-preview" + } + } + }, + "operationId": "TenantConfiguration_Save", + "title": "ApiManagementTenantConfigurationSave" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantConfigurationValidate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantConfigurationValidate.json new file mode 100644 index 000000000000..40be25596c21 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementTenantConfigurationValidate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "configurationName": "configuration", + "parameters": { + "properties": { + "branch": "master" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "6074ec02093a9d0dac3d7345", + "type": "Microsoft.ApiManagement/service/tenant/operationResults", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/tenant/configuration", + "properties": { + "actionLog": [], + "resultInfo": "Validation is successfull", + "started": "2021-04-13T00:55:30.62Z", + "status": "Succeeded", + "updated": "2021-04-13T00:55:39.857Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af64e2a6d2e0b688d751e?api-version=2024-10-01-preview" + } + } + }, + "operationId": "TenantConfiguration_Validate", + "title": "ApiManagementTenantConfigurationValidate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUndelete.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUndelete.json new file mode 100644 index 000000000000..65d389ba9dc7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUndelete.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "location": "South Central US", + "properties": { + "publisherEmail": "foo@contoso.com", + "publisherName": "foo", + "restore": true + }, + "sku": { + "name": "Developer", + "capacity": 1 + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAp3T4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "South Central US", + "properties": { + "apiVersionConstraint": {}, + "createdAtUtc": "2019-12-18T06:10:56.0327105Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-southcentralus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "23.102.171.124" + ], + "publisherEmail": "foo@contoso.com", + "publisherName": "foo", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Developer", + "capacity": 1 + } + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAp3P0=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "South Central US", + "properties": { + "apiVersionConstraint": {}, + "createdAtUtc": "2019-12-18T06:10:56.0327105Z", + "disableGateway": false, + "hostnameConfigurations": [ + { + "type": "Proxy", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "publisherEmail": "foo@contoso.com", + "publisherName": "foo", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Developer", + "capacity": 1 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementUndelete" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApi.json new file mode 100644 index 000000000000..506589d23367 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApi.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "parameters": { + "properties": { + "path": "newecho", + "displayName": "Echo API New", + "serviceUrl": "http://echoapi.cloudapp.net/api2" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "echo-api", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", + "properties": { + "path": "newecho", + "apiRevision": "1", + "displayName": "Echo API New", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "https" + ], + "serviceUrl": "http://echoapi.cloudapp.net/api2", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + } + } + }, + "operationId": "Api_Update", + "title": "ApiManagementUpdateApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiDiagnostic.json new file mode 100644 index 000000000000..11b3a39fd7fc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiDiagnostic.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "diagnosticId": "applicationinsights", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" + } + } + } + } + }, + "operationId": "ApiDiagnostic_Update", + "title": "ApiManagementUpdateApiDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiIssue.json new file mode 100644 index 000000000000..0a8e5637c3dd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiIssue.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "parameters": { + "properties": { + "state": "closed" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", + "properties": { + "description": "New API issue description", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "title": "New API issue", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + } + }, + "operationId": "ApiIssue_Update", + "title": "ApiManagementUpdateApiIssue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiOperation.json new file mode 100644 index 000000000000..04dfbc886381 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiOperation.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "operationId": "operationId", + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "parameters": { + "properties": { + "method": "GET", + "displayName": "Retrieve resource", + "templateParameters": [], + "urlTemplate": "/resource", + "request": { + "queryParameters": [ + { + "name": "param1", + "type": "string", + "description": "A sample parameter that is required and has a default value of \"sample\".", + "defaultValue": "sample", + "required": true, + "values": [ + "sample" + ] + } + ] + }, + "responses": [ + { + "description": "Returned in all cases.", + "headers": [], + "representations": [], + "statusCode": 200 + }, + { + "description": "Server Error.", + "headers": [], + "representations": [], + "statusCode": 500 + } + ] + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", + "properties": { + "method": "POST", + "displayName": "CancelOrder", + "templateParameters": [], + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", + "request": { + "description": "IFazioService_CancelOrder_InputMessage", + "headers": [], + "queryParameters": [], + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrder" + } + ] + }, + "responses": [ + { + "description": "IFazioService_CancelOrder_OutputMessage", + "headers": [], + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrderResponse" + } + ], + "statusCode": 200 + } + ] + } + } + } + }, + "operationId": "ApiOperation_Update", + "title": "ApiManagementUpdateApiOperation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiRelease.json new file mode 100644 index 000000000000..21a3a39ffffd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiRelease.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "a1", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "notes": "yahooagain" + } + }, + "releaseId": "testrev", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "testrev", + "type": "Microsoft.ApiManagement/service/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "createdDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo", + "updatedDateTime": "2018-02-08T20:38:29.173Z" + } + } + } + }, + "operationId": "ApiRelease_Update", + "title": "ApiManagementUpdateApiRelease" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiVersionSet.json new file mode 100644 index 000000000000..4558bf196f7b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiVersionSet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "description": "Version configuration", + "displayName": "api set 1", + "versioningScheme": "Segment" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "vs1" + }, + "responses": { + "200": { + "body": { + "name": "vs1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1", + "properties": { + "description": "Version configuration", + "displayName": "api set 1", + "versioningScheme": "Segment" + } + } + } + }, + "operationId": "ApiVersionSet_Update", + "title": "ApiManagementUpdateApiVersionSet" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiWiki.json new file mode 100644 index 000000000000..6f69a777b955 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateApiWiki.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "documents": [ + { + "documentationId": "docId1" + } + ] + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + } + ] + } + } + } + }, + "operationId": "ApiWiki_Update", + "title": "ApiManagementUpdateApiWiki" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateAuthorizationServer.json new file mode 100644 index 000000000000..8ed21a7755cb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateAuthorizationServer.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "authsid": "newauthServer", + "parameters": { + "properties": { + "clientId": "update", + "clientSecret": "updated", + "useInApiDocumentation": true, + "useInTestConsole": false + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", + "properties": { + "description": "test server", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientAuthenticationMethod": [ + "Basic" + ], + "clientId": "updated", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "defaultScope": "read write", + "displayName": "test3", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "resourceOwnerPassword": "pwd", + "resourceOwnerUsername": "un", + "supportState": true, + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "useInApiDocumentation": true, + "useInTestConsole": false + } + } + } + }, + "operationId": "AuthorizationServer_Update", + "title": "ApiManagementUpdateAuthorizationServer" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateBackend.json new file mode 100644 index 000000000000..d8bae2386787 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateBackend.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "backendId": "proxybackend", + "parameters": { + "properties": { + "description": "description5308", + "tls": { + "validateCertificateChain": false, + "validateCertificateName": true + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", + "properties": { + "description": "description5308", + "credentials": { + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + } + }, + "proxy": { + "password": "", + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": true + }, + "url": "https://backendname2644/", + "protocol": "http" + } + } + } + }, + "operationId": "Backend_Update", + "title": "ApiManagementUpdateBackend" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateCache.json new file mode 100644 index 000000000000..df3c9c879b9c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateCache.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "cacheId": "c1", + "parameters": { + "properties": { + "useFromLocation": "westindia" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "c1", + "type": "Microsoft.ApiManagement/service/caches", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", + "properties": { + "description": "Redis cache instances in West India", + "connectionString": "{{5f7fbca77a891a2200f3db38}}", + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1", + "useFromLocation": "westindia" + } + } + } + }, + "operationId": "Cache_Update", + "title": "ApiManagementUpdateCache" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateDiagnostic.json new file mode 100644 index 000000000000..70b9e40ffda7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateDiagnostic.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "diagnosticId": "applicationinsights", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + } + } + }, + "operationId": "Diagnostic_Update", + "title": "ApiManagementUpdateDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateDocumentation.json new file mode 100644 index 000000000000..8e4f5d895c06 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateDocumentation.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "documentationId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "content": "content updated", + "title": "Title updated" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/documentations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", + "properties": { + "content": "content updated", + "title": "Title updated" + } + } + } + }, + "operationId": "Documentation_Update", + "title": "ApiManagementUpdateDocumentation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateGateway.json new file mode 100644 index 000000000000..2324434dd227 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateGateway.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "gatewayId": "gw1", + "parameters": { + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "a1", + "type": "Microsoft.ApiManagement/service/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", + "properties": { + "description": "my gateway 1", + "locationData": { + "name": "my location" + } + } + } + } + }, + "operationId": "Gateway_Update", + "title": "ApiManagementUpdateGateway" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateGraphQLApiResolver.json new file mode 100644 index 000000000000..7b9e77d515e7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateGraphQLApiResolver.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "parameters": { + "properties": { + "path": "Query/adminUsers", + "description": "A GraphQL Resolver example", + "displayName": "Query AdminUsers" + } + }, + "resolverId": "resolverId", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc", + "properties": { + "path": "Query/adminUsers", + "description": "A GraphQL Resolver example", + "displayName": "Query AdminUsers" + } + } + } + }, + "operationId": "GraphQLApiResolver_Update", + "title": "ApiManagementUpdateGraphQLApiResolver" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateGroup.json new file mode 100644 index 000000000000..55c7fa9f31df --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateGroup.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "groupId": "tempgroup", + "parameters": { + "properties": { + "displayName": "temp group" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "tempgroup", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup", + "properties": { + "type": "external", + "description": "awesome group of people", + "builtIn": false, + "displayName": "tempgroup", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + } + } + }, + "operationId": "Group_Update", + "title": "ApiManagementUpdateGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateIdentityProvider.json new file mode 100644 index 000000000000..ec730ad229c7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateIdentityProvider.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "identityProviderName": "facebook", + "parameters": { + "properties": { + "clientId": "updatedfacebookid", + "clientSecret": "updatedfacebooksecret" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "AadB2C", + "type": "Microsoft.ApiManagement/service/identityProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C", + "properties": { + "type": "aadB2C", + "allowedTenants": [ + "contosoaadb2c.onmicrosoft.com", + "contoso2aadb2c.onmicrosoft.com" + ], + "authority": "login.microsoftonline.com", + "clientId": "f02dafe2-b8b8-48ec-a38e-27e5c16c51e5", + "signinPolicyName": "B2C_1_policy-signin", + "signinTenant": "contosoaadb2c.onmicrosoft.com", + "signupPolicyName": "B2C_1_policy-signup" + } + } + } + }, + "operationId": "IdentityProvider_Update", + "title": "ApiManagementUpdateIdentityProvider" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateLogger.json new file mode 100644 index 000000000000..c08b85851a57 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateLogger.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "loggerId": "eh1", + "parameters": { + "properties": { + "description": "updating description", + "loggerType": "azureEventHub" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "eh1", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1", + "properties": { + "description": "updating description", + "credentials": { + "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" + }, + "isBuffered": true, + "loggerType": "azureEventHub" + } + } + } + }, + "operationId": "Logger_Update", + "title": "ApiManagementUpdateLogger" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateNamedValue.json new file mode 100644 index 000000000000..2021f6d6812f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateNamedValue.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "namedValueId": "testprop2", + "parameters": { + "properties": { + "displayName": "prop3name", + "secret": false, + "tags": [ + "foo", + "bar2" + ], + "value": "propValue" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", + "properties": { + "displayName": "prop3name", + "secret": false, + "tags": [ + "foo", + "bar2" + ], + "value": "propValue" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + } + }, + "operationId": "NamedValue_Update", + "title": "ApiManagementUpdateNamedValue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateOpenIdConnectProvider.json new file mode 100644 index 000000000000..c24e39e71187 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateOpenIdConnectProvider.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "opid": "templateOpenIdConnect2", + "parameters": { + "properties": { + "clientSecret": "updatedsecret", + "useInApiDocumentation": true, + "useInTestConsole": false + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "templateOpenIdConnect2", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", + "properties": { + "description": "open id provider template2", + "clientId": "oidprovidertemplate2", + "displayName": "templateoidprovider2", + "metadataEndpoint": "https://oidprovider-template2.net", + "useInApiDocumentation": true, + "useInTestConsole": false + } + } + } + }, + "operationId": "OpenIdConnectProvider_Update", + "title": "ApiManagementUpdateOpenIdConnectProvider" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdatePolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdatePolicyRestriction.json new file mode 100644 index 000000000000..7e4af2f9a6ad --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdatePolicyRestriction.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "scope": "Sample Path 2 to the policy document." + } + }, + "policyRestrictionId": "policyRestriction1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "policyRestriction1", + "type": "Microsoft.ApiManagement/service/policyRestrictions", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", + "properties": { + "requireBase": "true", + "scope": "Sample Path 2 to the policy document." + } + } + } + }, + "operationId": "PolicyRestriction_Update", + "title": "ApiManagementUpdatePolicyRestriction" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdatePortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdatePortalConfig.json new file mode 100644 index 000000000000..f1f5276c036f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdatePortalConfig.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] + }, + "csp": { + "allowedSources": [ + "*.contoso.com" + ], + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ] + }, + "delegation": { + "delegateRegistration": false, + "delegateSubscription": false, + "delegationUrl": null, + "validationKey": null + }, + "enableBasicAuth": true, + "signin": { + "require": false + }, + "signup": { + "termsOfService": { + "requireConsent": false, + "text": "I agree to the service terms and conditions." + } + } + } + }, + "portalConfigId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.ApiManagement/service/portalconfigs", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", + "properties": { + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] + }, + "csp": { + "allowedSources": [ + "*.contoso.com" + ], + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ] + }, + "delegation": { + "delegateRegistration": false, + "delegateSubscription": false, + "delegationUrl": null, + "validationKey": null + }, + "enableBasicAuth": true, + "signin": { + "require": false + }, + "signup": { + "termsOfService": { + "requireConsent": false, + "text": "I agree to the service terms and conditions." + } + } + } + } + } + }, + "operationId": "PortalConfig_Update", + "title": "ApiManagementUpdatePortalConfig" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdatePortalRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdatePortalRevision.json new file mode 100644 index 000000000000..e9f759ecf6da --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdatePortalRevision.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "description": "portal revision update", + "isCurrent": true + } + }, + "portalRevisionId": "20201112101010", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "20201112101010", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", + "properties": { + "description": "portal revision update", + "createdDateTime": "2020-11-13T22:47:13.397Z", + "isCurrent": true, + "status": "completed", + "statusDetails": null, + "updatedDateTime": "2020-11-13T23:29:25.34Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5faf16b81d9a028970d0bfbb?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2024-10-01-preview&asyncId=5faf16b81d9a028970d0bfbb&asyncCode=200" + } + } + }, + "operationId": "PortalRevision_Update", + "title": "ApiManagementUpdatePortalRevision" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateProduct.json new file mode 100644 index 000000000000..8c4285316e5e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateProduct.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "displayName": "Test Template ProductName 4" + } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "testproduct", + "type": "Microsoft.ApiManagement/service/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct", + "properties": { + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "approvalRequired": true, + "displayName": "Test Template ProductName 4", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1 + } + } + } + }, + "operationId": "Product_Update", + "title": "ApiManagementUpdateProduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateProductWiki.json new file mode 100644 index 000000000000..61df3599607a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateProductWiki.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "documents": [ + { + "documentationId": "docId1" + } + ] + } + }, + "productId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", + "properties": { + "documents": [ + { + "documentationId": "docId1" + } + ] + } + } + } + }, + "operationId": "ProductWiki_Update", + "title": "ApiManagementUpdateProductWiki" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateQuotaCounterKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateQuotaCounterKey.json new file mode 100644 index 000000000000..2c38708e30fc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateQuotaCounterKey.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "callsCount": 0, + "kbTransferred": 2.5630078125 + } + }, + "quotaCounterKey": "ba", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "counterKey": "ba", + "periodEndTime": "2018-02-08T16:54:40Z", + "periodKey": "0_P3Y6M4DT12H30M5S", + "periodStartTime": "2014-08-04T04:24:35Z", + "value": { + "callsCount": 5, + "kbTransferred": 2.5830078125 + } + } + ] + } + } + }, + "operationId": "QuotaByCounterKeys_Update", + "title": "ApiManagementUpdateQuotaCounterKey" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json new file mode 100644 index 000000000000..9e58b559bcf3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "callsCount": 0, + "kbTransferred": 0 + } + }, + "quotaCounterKey": "ba", + "quotaPeriodKey": "0_P3Y6M4DT12H30M5S", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "counterKey": "ba", + "periodEndTime": "2018-02-08T16:54:40Z", + "periodKey": "0_P3Y6M4DT12H30M5S", + "periodStartTime": "2014-08-04T04:24:35Z", + "value": { + "callsCount": 0, + "kbTransferred": 2.5625 + } + } + } + }, + "operationId": "QuotaByPeriodKeys_Update", + "title": "ApiManagementUpdateQuotaCounterKeyByQuotaPeriod" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateServiceDisableTls10.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateServiceDisableTls10.json new file mode 100644 index 000000000000..fd4022858935 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateServiceDisableTls10.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAYRPs=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "West US", + "properties": { + "createdAtUtc": "2017-06-29T17:50:42.3191122Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False" + }, + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "40.86.176.232" + ], + "publisherEmail": "admin@live.com", + "publisherName": "Contoso", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "tags": { + "Owner": "sasolank", + "Pool": "Manual", + "Reserved": "", + "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT", + "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT", + "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_Update", + "title": "ApiManagementUpdateServiceDisableTls10" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateServicePublisherDetails.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateServicePublisherDetails.json new file mode 100644 index 000000000000..cfcc82e3dbde --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateServicePublisherDetails.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "publisherEmail": "foobar@live.com", + "publisherName": "Contoso Vnext" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAYRPs=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "West US", + "properties": { + "createdAtUtc": "2017-06-29T17:50:42.3191122Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False" + }, + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "40.86.176.232" + ], + "publisherEmail": "foobar@live.com", + "publisherName": "Contoso Vnext", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "tags": { + "Owner": "sasolank", + "Pool": "Manual", + "Reserved": "", + "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT", + "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT", + "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_Update", + "title": "ApiManagementUpdateServicePublisherDetails" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateServiceToNewVnetAndAZs.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateServiceToNewVnetAndAZs.json new file mode 100644 index 000000000000..70c9804eb46c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateServiceToNewVnetAndAZs.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "additionalLocations": [ + { + "location": "Australia East", + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip", + "sku": { + "name": "Premium", + "capacity": 3 + }, + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default" + }, + "zones": [ + "1", + "2", + "3" + ] + } + ], + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east", + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2" + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "Premium", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ] + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAWBIU=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "Japan East", + "properties": { + "additionalLocations": [ + { + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-australiaeast-01.regional.azure-api.net", + "location": "Australia East", + "platformVersion": "stv2", + "publicIPAddresses": [ + "20.213.1.35" + ], + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip", + "sku": { + "name": "Premium", + "capacity": 3 + }, + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default" + }, + "zones": [ + "1", + "2", + "3" + ] + } + ], + "createdAtUtc": "2021-04-08T23:41:35.6447381Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-japaneast-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": false, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + }, + { + "type": "Proxy", + "certificate": { + "expiry": "2022-06-09T23:59:59+00:00", + "subject": "CN=mycustomdomain.int-azure-api.net", + "thumbprint": "2994B5FFB8F76B3C687D324A8DEE0432C1ED18CD" + }, + "certificateSource": "Managed", + "defaultSslBinding": true, + "hostName": "mycustomdomain.int-azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "20.78.248.217" + ], + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east", + "publicNetworkAccess": "Enabled", + "publisherEmail": "contoso@microsoft.com", + "publisherName": "apimPublisher", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2" + }, + "virtualNetworkType": "Internal" + }, + "sku": { + "name": "Premium", + "capacity": 3 + }, + "systemData": { + "lastModifiedAt": "2022-01-21T20:04:21.6108974Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User" + }, + "zones": [ + "1", + "2", + "3" + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiManagementService_Update", + "title": "ApiManagementUpdateServiceToNewVnetAndAvailabilityZones" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateStandardGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateStandardGateway.json new file mode 100644 index 000000000000..d1fcc260ce61 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateStandardGateway.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "gatewayName": "apimGateway1", + "parameters": { + "properties": {}, + "sku": { + "name": "Standard", + "capacity": 10 + }, + "tags": { + "Name": "Contoso", + "Test": "User" + } + }, + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "apimGateway1", + "type": "Microsoft.ApiManagement/gateways", + "etag": "AAAAAAAmREI=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", + "location": "East US", + "properties": { + "backend": { + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" + } + }, + "configurationApi": { + "hostname": "apimGateway1.eastus.configuration.gateway.azure-api.net" + }, + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "frontend": { + "defaultHostname": "apimGateway1.eastus.gateway.azure-api.net" + }, + "provisioningState": "Succeeded", + "targetProvisioningState": "" + }, + "sku": { + "name": "Standard", + "capacity": 1 + }, + "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", + "createdBy": "user@contoso.com", + "createdByType": "User", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedBy": "user@contoso.com", + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } + } + }, + "operationId": "ApiGateway_Update", + "title": "ApiManagementUpdateStandardGateway" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateSubscription.json new file mode 100644 index 000000000000..8bfdfb70e51d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateSubscription.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "displayName": "testsub" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "testsub", + "type": "Microsoft.ApiManagement/service/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub", + "properties": { + "createdDate": "2017-06-02T17:59:06.223Z", + "displayName": "testsub", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "state": "submitted" + } + } + } + }, + "operationId": "Subscription_Update", + "title": "ApiManagementUpdateSubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateTag.json new file mode 100644 index 000000000000..3d9a6811b204 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateTag.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "displayName": "temp tag" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "temptag" + }, + "responses": { + "200": { + "body": { + "name": "temptag", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/temptag", + "properties": { + "displayName": "tag1" + } + } + } + }, + "operationId": "Tag_Update", + "title": "ApiManagementUpdateTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateTemplate.json new file mode 100644 index 000000000000..be42ad92e4c4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateTemplate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

\r\n We are happy to let you know that your request to publish the $AppName application in the gallery has been approved. Your application has been published and can be viewed here.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "subject": "Your request $IssueName was received" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "templateName": "newIssueNotificationMessage" + }, + "responses": { + "200": { + "body": { + "name": "NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", + "properties": { + "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "isDefault": true, + "parameters": [ + { + "name": "DevFirstName", + "title": "Developer first name" + }, + { + "name": "DevLastName", + "title": "Developer last name" + }, + { + "name": "IssueId", + "title": "Issue id" + }, + { + "name": "IssueName", + "title": "Issue name" + }, + { + "name": "OrganizationName", + "title": "Organization name" + }, + { + "name": "DevPortalUrl", + "title": "Developer portal URL" + } + ], + "subject": "Your request $IssueName was received", + "title": "New issue received" + } + } + } + }, + "operationId": "EmailTemplate_Update", + "title": "ApiManagementUpdateTemplate" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateTenantAccess.json new file mode 100644 index 000000000000..5fe24d0961aa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateTenantAccess.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "If-Match": "*", + "accessName": "access", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "enabled": true + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "access", + "type": "Microsoft.ApiManagement/service/tenant", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", + "properties": { + "enabled": true + } + } + } + }, + "operationId": "TenantAccess_Update", + "title": "ApiManagementUpdateTenantAccess" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateUser.json new file mode 100644 index 000000000000..a34f719e8fc2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateUser.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "email": "foobar@outlook.com", + "firstName": "foo", + "lastName": "bar" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512a88c680b" + }, + "responses": { + "200": { + "body": { + "name": "5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "properties": { + "email": "foobar@outlook.com", + "firstName": "foo", + "identities": [ + { + "id": "*************", + "provider": "Microsoft" + } + ], + "lastName": "bar", + "registrationDate": "2017-06-02T17:58:50.357Z", + "state": "active" + } + } + } + }, + "operationId": "User_Update", + "title": "ApiManagementUpdateUser" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspace.json new file mode 100644 index 000000000000..66835e5f937d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspace.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "description": "workspace 1", + "displayName": "my workspace" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", + "properties": { + "description": "workspace 1", + "displayName": "my workspace" + } + } + } + }, + "operationId": "Workspace_Update", + "title": "ApiManagementUpdateWorkspace" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApi.json new file mode 100644 index 000000000000..1b54df93b89e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApi.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "parameters": { + "properties": { + "path": "newecho", + "displayName": "Echo API New", + "serviceUrl": "http://echoapi.cloudapp.net/api2" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "echo-api", + "type": "Microsoft.ApiManagement/service/workspaces/pis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api", + "properties": { + "path": "newecho", + "apiRevision": "1", + "displayName": "Echo API New", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "https" + ], + "serviceUrl": "http://echoapi.cloudapp.net/api2", + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + } + } + } + } + }, + "operationId": "WorkspaceApi_Update", + "title": "ApiManagementUpdateWorkspaceApi" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApiDiagnostic.json new file mode 100644 index 000000000000..3c3d92992b3d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApiDiagnostic.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "diagnosticId": "applicationinsights", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 100 + }, + "headers": [] + }, + "request": { + "body": { + "bytes": 100 + }, + "headers": [] + } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" + } + } + } + } + }, + "operationId": "WorkspaceApiDiagnostic_Update", + "title": "ApiManagementUpdateWorkspaceApiDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApiOperation.json new file mode 100644 index 000000000000..7d8d78ebe10a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApiOperation.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "operationId": "operationId", + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "parameters": { + "properties": { + "method": "GET", + "displayName": "Retrieve resource", + "templateParameters": [], + "urlTemplate": "/resource", + "request": { + "queryParameters": [ + { + "name": "param1", + "type": "string", + "description": "A sample parameter that is required and has a default value of \"sample\".", + "defaultValue": "sample", + "required": true, + "values": [ + "sample" + ] + } + ] + }, + "responses": [ + { + "description": "Returned in all cases.", + "headers": [], + "representations": [], + "statusCode": 200 + }, + { + "description": "Server Error.", + "headers": [], + "representations": [], + "statusCode": 500 + } + ] + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", + "properties": { + "method": "POST", + "displayName": "CancelOrder", + "templateParameters": [], + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", + "request": { + "description": "IFazioService_CancelOrder_InputMessage", + "headers": [], + "queryParameters": [], + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrder" + } + ] + }, + "responses": [ + { + "description": "IFazioService_CancelOrder_OutputMessage", + "headers": [], + "representations": [ + { + "contentType": "text/xml", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrderResponse" + } + ], + "statusCode": 200 + } + ] + } + } + } + }, + "operationId": "WorkspaceApiOperation_Update", + "title": "ApiManagementUpdateWorkspaceApiOperation" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApiRelease.json new file mode 100644 index 000000000000..7eb8b364b64b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApiRelease.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "a1", + "parameters": { + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", + "notes": "yahooagain" + } + }, + "releaseId": "testrev", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "testrev", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/testrev", + "properties": { + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", + "createdDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo", + "updatedDateTime": "2018-02-08T20:38:29.173Z" + } + } + } + }, + "operationId": "WorkspaceApiRelease_Update", + "title": "ApiManagementUpdateWorkspaceApiRelease" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApiVersionSet.json new file mode 100644 index 000000000000..73ed166cea39 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceApiVersionSet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "description": "Version configuration", + "displayName": "api set 1", + "versioningScheme": "Segment" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "vs1", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "vs1", + "type": "Microsoft.ApiManagement/service/workspaces.api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs1", + "properties": { + "description": "Version configuration", + "displayName": "api set 1", + "versioningScheme": "Segment" + } + } + } + }, + "operationId": "WorkspaceApiVersionSet_Update", + "title": "ApiManagementUpdateWorkspaceApiVersionSet" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceBackend.json new file mode 100644 index 000000000000..190fb0419d87 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceBackend.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "backendId": "proxybackend", + "parameters": { + "properties": { + "description": "description5308", + "tls": { + "validateCertificateChain": false, + "validateCertificateName": true + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", + "properties": { + "description": "description5308", + "credentials": { + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + } + }, + "proxy": { + "password": "", + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": true + }, + "url": "https://backendname2644/", + "protocol": "http" + } + } + } + }, + "operationId": "WorkspaceBackend_Update", + "title": "ApiManagementUpdateWorkspaceBackend" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceDiagnostic.json new file mode 100644 index 000000000000..080abc2b635f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceDiagnostic.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "diagnosticId": "applicationinsights", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "backend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "frontend": { + "response": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + }, + "request": { + "body": { + "bytes": 512 + }, + "headers": [ + "Content-type" + ] + } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "percentage": 50, + "samplingType": "fixed" + } + } + } + } + }, + "operationId": "WorkspaceDiagnostic_Update", + "title": "ApiManagementUpdateWorkspaceDiagnostic" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceGroup.json new file mode 100644 index 000000000000..9d1b2d3b99e4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceGroup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "groupId": "tempgroup", + "parameters": { + "properties": { + "displayName": "temp group" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "tempgroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup", + "properties": { + "type": "external", + "description": "awesome group of people", + "builtIn": false, + "displayName": "tempgroup", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + } + } + }, + "operationId": "WorkspaceGroup_Update", + "title": "ApiManagementUpdateWorkspaceGroup" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceLogger.json new file mode 100644 index 000000000000..6506cc483a76 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceLogger.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "loggerId": "eh1", + "parameters": { + "properties": { + "description": "updating description", + "loggerType": "azureEventHub" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "eh1", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1", + "properties": { + "description": "updating description", + "credentials": { + "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" + }, + "isBuffered": true, + "loggerType": "azureEventHub" + } + } + } + }, + "operationId": "WorkspaceLogger_Update", + "title": "ApiManagementUpdateWorkspaceLogger" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceNamedValue.json new file mode 100644 index 000000000000..195a4834731c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceNamedValue.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "namedValueId": "testprop2", + "parameters": { + "properties": { + "displayName": "prop3name", + "secret": false, + "tags": [ + "foo", + "bar2" + ], + "value": "propValue" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2", + "properties": { + "displayName": "prop3name", + "secret": false, + "tags": [ + "foo", + "bar2" + ], + "value": "propValue" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + } + }, + "operationId": "WorkspaceNamedValue_Update", + "title": "ApiManagementUpdateWorkspaceNamedValue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceProduct.json new file mode 100644 index 000000000000..ac24e9e85068 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceProduct.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "displayName": "Test Template ProductName 4" + } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "testproduct", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct", + "properties": { + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "approvalRequired": true, + "displayName": "Test Template ProductName 4", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1 + } + } + } + }, + "operationId": "WorkspaceProduct_Update", + "title": "ApiManagementUpdateWorkspaceProduct" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceSubscription.json new file mode 100644 index 000000000000..c81b7e2b0d00 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceSubscription.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "displayName": "testsub" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "testsub", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub", + "properties": { + "createdDate": "2017-06-02T17:59:06.223Z", + "displayName": "testsub", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", + "state": "submitted" + } + } + } + }, + "operationId": "WorkspaceSubscription_Update", + "title": "ApiManagementUpdateWorkspaceSubscription" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceTag.json new file mode 100644 index 000000000000..af5fd724428d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUpdateWorkspaceTag.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "If-Match": "*", + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "displayName": "temp tag" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "temptag", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "name": "temptag", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/temptag", + "properties": { + "displayName": "tag1" + } + } + } + }, + "operationId": "WorkspaceTag_Update", + "title": "ApiManagementUpdateWorkspaceTag" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUserConfirmationPasswordSend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUserConfirmationPasswordSend.json new file mode 100644 index 000000000000..1c25dc7d0f87 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUserConfirmationPasswordSend.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "57127d485157a511ace86ae7" + }, + "responses": { + "204": {} + }, + "operationId": "UserConfirmationPassword_Send", + "title": "ApiManagementUserConfirmationPasswordSend" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUserGenerateSsoUrl.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUserGenerateSsoUrl.json new file mode 100644 index 000000000000..50e345c8276d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUserGenerateSsoUrl.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "57127d485157a511ace86ae7" + }, + "responses": { + "200": { + "body": { + "value": "https://apimService1.portal.azure-api.net/signin-sso?token=57127d485157a511ace86ae7%26201706051624%267VY18MlwAom***********2bYr2bDQHg21OzQsNakExQ%3d%3d" + } + } + }, + "operationId": "User_GenerateSsoUrl", + "title": "ApiManagementUserGenerateSsoUrl" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUserToken.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUserToken.json new file mode 100644 index 000000000000..03c911748e23 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementUserToken.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "parameters": { + "properties": { + "expiry": "2019-04-21T00:44:24.2845269Z", + "keyType": "primary" + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "userId1718" + }, + "responses": { + "200": { + "body": { + "value": "userId1718&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg==" + } + } + }, + "operationId": "User_GetSharedAccessToken", + "title": "ApiManagementUserToken" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementValidatePolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementValidatePolicies.json new file mode 100644 index 000000000000..107f207c4b94 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementValidatePolicies.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "6074e652093a9d0dac3d733c", + "type": "Microsoft.ApiManagement/service/tenant/operationResults", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1", + "properties": { + "actionLog": [], + "resultInfo": "All the policies were validated", + "started": "2023-04-13T00:31:14.94Z", + "status": "Succeeded", + "updated": "2023-04-13T00:31:27.59Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ApiManagement/service/apimService1/validatePolicies?api-version=2023-05-01" + } + } + }, + "operationId": "PolicyRestrictionValidations_ByService", + "title": "ApiManagementListPolicyRestrictions" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementWorkspaceNamedValueListValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementWorkspaceNamedValueListValue.json new file mode 100644 index 000000000000..6e4993e2e805 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementWorkspaceNamedValueListValue.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "namedValueId": "testarmTemplateproperties2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "value": "propValue" + } + } + }, + "operationId": "WorkspaceNamedValue_ListValue", + "title": "ApiManagementWorkspaceNamedValueListValue" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementWorkspaceSubscriptionListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementWorkspaceSubscriptionListSecrets.json new file mode 100644 index 000000000000..b6560433bb86 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementWorkspaceSubscriptionListSecrets.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "5931a769d8d14f0ad8ce13b8", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + }, + "operationId": "WorkspaceSubscription_ListSecrets", + "title": "ApiManagementWorkspaceSubscriptionListSecrets" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey.json new file mode 100644 index 000000000000..1c72d1b9ca75 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "204": {} + }, + "operationId": "WorkspaceSubscription_RegeneratePrimaryKey", + "title": "ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey.json new file mode 100644 index 000000000000..87b99d926e16 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/examples/2024-10-01-preview/ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" + }, + "responses": { + "204": {} + }, + "operationId": "WorkspaceSubscription_RegenerateSecondaryKey", + "title": "ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/main.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/main.tsp new file mode 100644 index 000000000000..944d51a1ed1e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/main.tsp @@ -0,0 +1,114 @@ +/** + * PLEASE DO NOT REMOVE - USED FOR CONVERTER METRICS + * Generated by package: @autorest/openapi-to-typespec + * Parameters used: + * isFullCompatible: true + * guessResourceKey: false + * Version: 0.11.5 + * Date: 2025-09-22T02:42:50.583Z + */ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models.tsp"; +import "./back-compatible.tsp"; +import "./ApiManagementGatewayResource.tsp"; +import "./ApiContract.tsp"; +import "./ApiReleaseContract.tsp"; +import "./OperationContract.tsp"; +import "./PolicyContract.tsp"; +import "./TagContract.tsp"; +import "./ResolverContract.tsp"; +import "./SchemaContract.tsp"; +import "./DiagnosticContract.tsp"; +import "./IssueContract.tsp"; +import "./IssueCommentContract.tsp"; +import "./IssueAttachmentContract.tsp"; +import "./TagDescriptionContract.tsp"; +import "./WikiContract.tsp"; +import "./ApiVersionSetContract.tsp"; +import "./AuthorizationProviderContract.tsp"; +import "./AuthorizationContract.tsp"; +import "./AuthorizationAccessPolicyContract.tsp"; +import "./AuthorizationServerContract.tsp"; +import "./BackendContract.tsp"; +import "./CacheContract.tsp"; +import "./CertificateContract.tsp"; +import "./ContentTypeContract.tsp"; +import "./ContentItemContract.tsp"; +import "./DeletedServiceContract.tsp"; +import "./ApiManagementServiceResource.tsp"; +import "./DocumentationContract.tsp"; +import "./EmailTemplateContract.tsp"; +import "./ApiManagementGatewayConfigConnectionResource.tsp"; +import "./GatewayContract.tsp"; +import "./GatewayHostnameConfigurationContract.tsp"; +import "./GatewayCertificateAuthorityContract.tsp"; +import "./GroupContract.tsp"; +import "./IdentityProviderContract.tsp"; +import "./LoggerContract.tsp"; +import "./NamedValueContract.tsp"; +import "./NotificationContract.tsp"; +import "./OpenidConnectProviderContract.tsp"; +import "./PolicyFragmentContract.tsp"; +import "./PolicyRestrictionContract.tsp"; +import "./PortalConfigContract.tsp"; +import "./ClientApplicationContract.tsp"; +import "./ClientApplicationProductLinkContract.tsp"; +import "./PortalRevisionContract.tsp"; +import "./PortalSigninSettings.tsp"; +import "./PortalSignupSettings.tsp"; +import "./PortalDelegationSettings.tsp"; +import "./PrivateEndpointConnection.tsp"; +import "./PrivateLinkResource.tsp"; +import "./ProductContract.tsp"; +import "./ProductApiLinkContract.tsp"; +import "./ProductGroupLinkContract.tsp"; +import "./GlobalSchemaContract.tsp"; +import "./TenantSettingsContract.tsp"; +import "./SubscriptionContract.tsp"; +import "./TagApiLinkContract.tsp"; +import "./TagOperationLinkContract.tsp"; +import "./TagProductLinkContract.tsp"; +import "./AccessInformationContract.tsp"; +import "./UserContract.tsp"; +import "./ApiManagementWorkspaceLinksResource.tsp"; +import "./WorkspaceContract.tsp"; +import "./routes.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; +/** + * Resource provider operation status. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armProviderNamespace +@service(#{ title: "ApiManagementClient" }) +@versioned(Versions) +// FIXME: Common type version v2 is not supported for now. Set to v3. +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.ApiManagement; + +/** + * The available API versions. + */ +enum Versions { + /** + * The 2024-10-01-preview API version. + */ + v2024_10_01_preview: "2024-10-01-preview", +} +@armResourceOperations +interface ApiManagementOperations + extends Azure.ResourceManager.Legacy.Operations< + ArmResponse, + ErrorResponse + > {} +@@doc(ApiManagementOperations.list, + "Lists all of the available REST API operations of the Microsoft.ApiManagement provider." +); diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/models.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/models.tsp new file mode 100644 index 000000000000..e511fcfe6ecc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/models.tsp @@ -0,0 +1,10671 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.Core; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; + +namespace Microsoft.ApiManagement; + +/** + * The type of VPN in which API Management gateway needs to be configured in. + */ +union VirtualNetworkType { + string, + + /** + * The API Management gateway is not part of any Virtual Network. + */ + None: "None", + + /** + * The API Management gateway is part of Virtual Network and it is accessible from Internet. + */ + External: "External", + + /** + * The API Management gateway is part of Virtual Network and it is only accessible from within the virtual network. + */ + Internal: "Internal", +} + +/** + * Name of the Sku. + */ +union ApiGatewaySkuType { + string, + + /** + * Standard SKU of the API gateway. + */ + Standard: "Standard", + + /** + * Standard SKU of the API gateway to be used in Workspaces. + */ + WorkspaceGatewayStandard: "WorkspaceGatewayStandard", + + /** + * Premium SKU of the API gateway to be used in Workspaces. + */ + WorkspaceGatewayPremium: "WorkspaceGatewayPremium", +} + +/** + * The type of identity that created the resource. + */ +union CreatedByType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + User: "User", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Application: "Application", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ManagedIdentity: "ManagedIdentity", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Key: "Key", +} + +/** + * The scale type applicable to the sku. + */ +union GatewaySkuCapacityScaleType { + string, + + /** + * Supported scale type automatic. + */ + Automatic: "Automatic", + + /** + * Supported scale type manual. + */ + Manual: "Manual", + + /** + * Scaling not supported. + */ + None: "None", +} + +/** + * Policy Restriction Compliance State + */ +union PolicyComplianceState { + string, + + /** + * The policy restriction compliance state has not yet been determined. + */ + Pending: "Pending", + + /** + * The scope in restriction is out of compliance. + */ + NonCompliant: "NonCompliant", + + /** + * The scope in restriction is in compliance. + */ + Compliant: "Compliant", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union Protocol { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + http: "http", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + https: "https", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ws: "ws", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + wss: "wss", +} + +/** + * An value that determines where the API Version identifier will be located in a HTTP request. + */ +union VersioningScheme { + string, + + /** + * The API Version is passed in a path segment. + */ + Segment: "Segment", + + /** + * The API Version is passed in a query parameter. + */ + Query: "Query", + + /** + * The API Version is passed in a HTTP header. + */ + Header: "Header", +} + +/** + * Form of an authorization grant, which the client uses to request the access token. + */ +union BearerTokenSendingMethods { + string, + + /** + * Access token will be transmitted in the Authorization header using Bearer schema + */ + authorizationHeader: "authorizationHeader", + + /** + * Access token will be transmitted as query parameters. + */ + query: "query", +} + +/** + * Type of API. + */ +union ApiType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + http: "http", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + soap: "soap", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + websocket: "websocket", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + graphql: "graphql", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + odata: "odata", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + grpc: "grpc", +} + +/** + * Format of the Content in which the API is getting imported. New formats can be added in the future + */ +union ContentFormat { + string, + + /** + * The contents are inline and Content type is a WADL document. + */ + `wadl-xml`: "wadl-xml", + + /** + * The WADL document is hosted on a publicly accessible internet address. + */ + `wadl-link-json`: "wadl-link-json", + + /** + * The contents are inline and Content Type is a OpenAPI 2.0 JSON Document. + */ + `swagger-json`: "swagger-json", + + /** + * The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address. + */ + `swagger-link-json`: "swagger-link-json", + + /** + * The contents are inline and the document is a WSDL/Soap document. + */ + wsdl: "wsdl", + + /** + * The WSDL document is hosted on a publicly accessible internet address. + */ + `wsdl-link`: "wsdl-link", + + /** + * The contents are inline and Content Type is a OpenAPI 3.0 YAML Document. + */ + openapi: "openapi", + + /** + * The contents are inline and Content Type is a OpenAPI 3.0 JSON Document. + */ + `openapi+json`: "openapi+json", + + /** + * The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address. + */ + `openapi-link`: "openapi-link", + + /** + * The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address. + */ + `openapi+json-link`: "openapi+json-link", + + /** + * The GraphQL API endpoint hosted on a publicly accessible internet address. + */ + `graphql-link`: "graphql-link", + + /** + * The contents are inline and Content Type is a OData XML Document. + */ + odata: "odata", + + /** + * The OData metadata document hosted on a publicly accessible internet address. + */ + `odata-link`: "odata-link", + + /** + * The contents are inline and Content Type is a gRPC protobuf file. + */ + grpc: "grpc", + + /** + * The gRPC protobuf file is hosted on a publicly accessible internet address. + */ + `grpc-link`: "grpc-link", +} + +/** + * Type of API to create. + * * `http` creates a REST API + * * `soap` creates a SOAP pass-through API + * * `websocket` creates websocket API + * * `graphql` creates GraphQL API. + * New types can be added in the future. + */ +union SoapApiType { + string, + + /** + * Imports a SOAP API having a RESTful front end. + */ + SoapToRest: "http", + + /** + * Imports the SOAP API having a SOAP front end. + */ + SoapPassThrough: "soap", + + /** + * Imports the API having a Websocket front end. + */ + WebSocket: "websocket", + + /** + * Imports the API having a GraphQL front end. + */ + GraphQL: "graphql", + + /** + * Imports the API having a OData front end. + */ + OData: "odata", + + /** + * Imports the API having a gRPC front end. + */ + gRPC: "grpc", +} + +/** + * Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query' + */ +union TranslateRequiredQueryParametersConduct { + string, + + /** + * Translates required query parameters to template ones. Is a default value + */ + Template: "template", + + /** + * Leaves required query parameters as they are (no translation done). + */ + Query: "query", +} + +/** + * Format of the policyContent. + */ +union PolicyContentFormat { + string, + + /** + * The contents are inline and Content type is an XML document. + */ + xml: "xml", + + /** + * The policy XML document is hosted on a HTTP endpoint accessible from the API Management service. + */ + `xml-link`: "xml-link", + + /** + * The contents are inline and Content type is a non XML encoded policy document. + */ + rawxml: "rawxml", + + /** + * The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service. + */ + `rawxml-link`: "rawxml-link", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union PolicyIdName { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + policy: "policy", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union PolicyExportFormat { + string, + + /** + * The contents are inline and Content type is an XML document. + */ + xml: "xml", + + /** + * The contents are inline and Content type is a non XML encoded policy document. + */ + rawxml: "rawxml", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union ProductAuthType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `subscription-key`: "subscription-key", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `application-token`: "application-token", +} + +/** + * Specifies for what type of messages sampling settings should not apply. + */ +union AlwaysLog { + string, + + /** + * Always log all erroneous request regardless of sampling settings. + */ + allErrors: "allErrors", +} + +/** + * Sampling type. + */ +union SamplingType { + string, + + /** + * Fixed-rate sampling. + */ + fixed: "fixed", +} + +/** + * Data masking mode. + */ +union DataMaskingMode { + string, + + /** + * Mask the value of an entity. + */ + Mask: "Mask", + + /** + * Hide the presence of an entity. + */ + Hide: "Hide", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union LlmDiagnosticSettings { + string, + + /** + * Default LLM logs are enabled. + */ + enabled: "enabled", + + /** + * Default LLM logs are disabled. + */ + disabled: "disabled", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union LlmMessageLogTypes { + string, + + /** + * Log all messages. + */ + all: "all", +} + +/** + * Sets correlation protocol to use for Application Insights diagnostics. + */ +union HttpCorrelationProtocol { + string, + + /** + * Do not read and inject correlation headers. + */ + None: "None", + + /** + * Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. + */ + Legacy: "Legacy", + + /** + * Inject Trace Context headers. See https://w3c.github.io/trace-context. + */ + W3C: "W3C", +} + +/** + * The verbosity level applied to traces emitted by trace policies. + */ +union Verbosity { + string, + + /** + * All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance. + */ + verbose: "verbose", + + /** + * Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance. + */ + information: "information", + + /** + * Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance. + */ + error: "error", +} + +/** + * The format of the Operation Name for Application Insights telemetries. Default is Name. + */ +union OperationNameFormat { + string, + + /** + * API_NAME;rev=API_REVISION - OPERATION_NAME + */ + Name: "Name", + + /** + * HTTP_VERB URL + */ + Url: "Url", +} + +/** + * Status of the issue. + */ +union State { + string, + + /** + * The issue is proposed. + */ + proposed: "proposed", + + /** + * The issue is opened. + */ + open: "open", + + /** + * The issue was removed. + */ + removed: "removed", + + /** + * The issue is now resolved. + */ + resolved: "resolved", + + /** + * The issue was closed. + */ + closed: "closed", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union ExportFormat { + string, + + /** + * Export the Api Definition in OpenAPI 2.0 Specification as JSON document to the Storage Blob. + */ + Swagger: "swagger-link", + + /** + * Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap` + */ + Wsdl: "wsdl-link", + + /** + * Export the Api Definition in WADL Schema to Storage Blob. + */ + Wadl: "wadl-link", + + /** + * Export the Api Definition in OpenAPI 3.0 Specification as YAML document to Storage Blob. + */ + Openapi: "openapi-link", + + /** + * Export the Api Definition in OpenAPI 3.0 Specification as JSON document to Storage Blob. + */ + OpenapiJson: "openapi+json-link", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union ExportApi { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `true`: "true", +} + +/** + * Format in which the API Details are exported to the Storage Blob with Sas Key valid for 5 minutes. + */ +union ExportResultFormat { + string, + + /** + * The API Definition is exported in OpenAPI Specification 2.0 format to the Storage Blob. + */ + Swagger: "swagger-link-json", + + /** + * Export the API Definition in WADL Schema to Storage Blob. + */ + Wadl: "wadl-link-json", + + /** + * The API Definition is exported in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap` + */ + Wsdl: "wsdl-link+xml", + + /** + * Export the API Definition in OpenAPI Specification 3.0 to Storage Blob. + */ + OpenApi: "openapi-link", +} + +/** + * Authorization type options + */ +union AuthorizationType { + string, + + /** + * OAuth2 authorization type + */ + OAuth2: "OAuth2", +} + +/** + * OAuth2 grant type options + */ +union OAuth2GrantType { + string, + + /** + * Authorization Code grant + */ + AuthorizationCode: "AuthorizationCode", + + /** + * Client Credential grant + */ + ClientCredentials: "ClientCredentials", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union GrantType { + string, + + /** + * Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1. + */ + authorizationCode: "authorizationCode", + + /** + * Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2. + */ + implicit: "implicit", + + /** + * Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3. + */ + resourceOwnerPassword: "resourceOwnerPassword", + + /** + * Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4. + */ + clientCredentials: "clientCredentials", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union ClientAuthenticationMethod { + string, + + /** + * Basic Client Authentication method. + */ + Basic: "Basic", + + /** + * Body based Authentication method. + */ + Body: "Body", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union BearerTokenSendingMethod { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + authorizationHeader: "authorizationHeader", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + query: "query", +} + +/** + * Backend communication protocol. Required when backend type is 'Single'. + */ +union BackendProtocol { + string, + + /** + * The Backend is a RESTful service. + */ + http: "http", + + /** + * The Backend is a SOAP service. + */ + soap: "soap", +} + +/** + * Source from where the session id is extracted. + */ +union BackendSessionIdSource { + string, + + /** + * The session id is set by APIM gateway in a cookie and is extracted from the cookies in client requests. + */ + cookie: "cookie", +} + +/** + * Type of the backend. A backend can be either Single or Pool. + */ +union BackendType { + string, + + /** + * supports single backend + */ + Single: "Single", + + /** + * supports pool backend + */ + Pool: "Pool", +} + +/** + * The IP version to be used. Only IPv4 is supported for now. + */ +union PreferredIPVersion { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + IPv4: "IPv4", +} + +/** + * The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value. + */ +union ConnectivityCheckProtocol { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + TCP: "TCP", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + HTTP: "HTTP", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + HTTPS: "HTTPS", +} + +/** + * The HTTP method to be used. + */ +union Method { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + GET: "GET", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + POST: "POST", +} + +/** + * The origin of the issue. + */ +union Origin { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Local: "Local", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Inbound: "Inbound", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Outbound: "Outbound", +} + +/** + * The severity of the issue. + */ +union Severity { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Error: "Error", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Warning: "Warning", +} + +/** + * The type of issue. + */ +union IssueType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Unknown: "Unknown", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + AgentStopped: "AgentStopped", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + GuestFirewall: "GuestFirewall", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + DnsResolution: "DnsResolution", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + SocketBind: "SocketBind", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + NetworkSecurityRule: "NetworkSecurityRule", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + UserDefinedRoute: "UserDefinedRoute", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + PortThrottled: "PortThrottled", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Platform: "Platform", +} + +/** + * The connection status. + */ +union ConnectionStatus { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Unknown: "Unknown", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Connected: "Connected", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Disconnected: "Disconnected", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Degraded: "Degraded", +} + +/** + * Name of the Sku. + */ +union SkuType { + string, + + /** + * Developer SKU of Api Management. + */ + Developer: "Developer", + + /** + * Standard SKU of Api Management. + */ + Standard: "Standard", + + /** + * Premium SKU of Api Management. + */ + Premium: "Premium", + + /** + * Basic SKU of Api Management. + */ + Basic: "Basic", + + /** + * Consumption SKU of Api Management. + */ + Consumption: "Consumption", + + /** + * Isolated SKU of Api Management. + */ + Isolated: "Isolated", + + /** + * BasicV2 SKU of Api Management. + */ + BasicV2: "BasicV2", + + /** + * StandardV2 SKU of Api Management. + */ + StandardV2: "StandardV2", +} + +/** + * The scale type applicable to the sku. + */ +union ResourceSkuCapacityScaleType { + string, + + /** + * Supported scale type automatic. + */ + automatic: "automatic", + + /** + * Supported scale type manual. + */ + manual: "manual", + + /** + * Scaling not supported. + */ + none: "none", +} + +/** + * The type of access to be used for the storage account. + */ +union AccessType { + string, + + /** + * Use access key. + */ + AccessKey: "AccessKey", + + /** + * Use system assigned managed identity. + */ + SystemAssignedManagedIdentity: "SystemAssignedManagedIdentity", + + /** + * Use user assigned managed identity. + */ + UserAssignedManagedIdentity: "UserAssignedManagedIdentity", +} + +/** + * Hostname type. + */ +union HostnameType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Proxy: "Proxy", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Portal: "Portal", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Management: "Management", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Scm: "Scm", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + DeveloperPortal: "DeveloperPortal", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ConfigurationApi: "ConfigurationApi", +} + +/** + * Certificate Source. + */ +union CertificateSource { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Managed: "Managed", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + KeyVault: "KeyVault", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Custom: "Custom", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + BuiltIn: "BuiltIn", +} + +/** + * Certificate Status. + */ +union CertificateStatus { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Completed: "Completed", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Failed: "Failed", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + InProgress: "InProgress", +} + +/** + * Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' + */ +union PublicNetworkAccess { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Enabled: "Enabled", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Disabled: "Disabled", +} + +/** + * Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled' + */ +union LegacyApiState { + string, + + /** + * Legacy Configuration API (v1) is enabled for the service and self-hosted gateways can connect to it. + */ + Enabled: "Enabled", + + /** + * Legacy Configuration API (v1) is disabled for the service and self-hosted gateways can not connect to it. + */ + Disabled: "Disabled", +} + +/** + * Property can be used to enable NAT Gateway for this API Management service. + */ +union NatGatewayState { + string, + + /** + * Nat Gateway is enabled for the service. + */ + Enabled: "Enabled", + + /** + * Nat Gateway is disabled for the service. + */ + Disabled: "Disabled", +} + +/** + * Compute Platform Version running the service. + */ +union PlatformVersion { + string, + + /** + * Platform version cannot be determined, as compute platform is not deployed. + */ + undetermined: "undetermined", + + /** + * Platform running the service on Single Tenant V1 platform. + */ + stv1: "stv1", + + /** + * Platform running the service on Single Tenant V2 platform. + */ + stv2: "stv2", + + /** + * Platform running the service on Multi Tenant V1 platform. + */ + mtv1: "mtv1", + + /** + * Platform running the service on Single Tenant V2 platform on newer Hardware. + */ + `stv2.1`: "stv2.1", +} + +/** + * The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. + */ +union CertificateConfigurationStoreName { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + CertificateAuthority: "CertificateAuthority", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Root: "Root", +} + +/** + * Status of legacy portal in the API Management service. + */ +union LegacyPortalStatus { + string, + + /** + * Legacy Portal is enabled for the service. + */ + Enabled: "Enabled", + + /** + * Legacy Portal is disabled for the service. + */ + Disabled: "Disabled", +} + +/** + * Status of developer portal in this API Management service. + */ +union DeveloperPortalStatus { + string, + + /** + * Developer Portal is enabled for the service. + */ + Enabled: "Enabled", + + /** + * Developer Portal is disabled for the service. + */ + Disabled: "Disabled", +} + +/** + * Release Channel of this API Management service. + */ +union ReleaseChannel { + string, + + /** + * Preview Channel of the service. + */ + Preview: "Preview", + + /** + * Default Channel of the service. + */ + Default: "Default", + + /** + * Stable Channel of the service. + */ + Stable: "Stable", +} + +/** + * The type of identity used for the resource. 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 service. + */ +union ApimIdentityType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + SystemAssigned: "SystemAssigned", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + UserAssigned: "UserAssigned", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `SystemAssigned, UserAssigned`: "SystemAssigned, UserAssigned", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + None: "None", +} + +/** + * Mode of Migration to stv2. Default is PreserveIp. + */ +union MigrateToStv2Mode { + string, + + /** + * Migrate API Management service to stv2 from stv1, by reserving the IP Address of the service. This will have a downtime of upto 15 minutes, while the IP address is getting migrate to new infrastructure. + */ + PreserveIp: "PreserveIp", + + /** + * Migrate API Management service to stv2 from stv1. This will have no downtime as the service configuration will be migrated to new infrastructure, but the IP address will changed. + */ + NewIP: "NewIP", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union TemplateName { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + applicationApprovedNotificationMessage: "applicationApprovedNotificationMessage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + accountClosedDeveloper: "accountClosedDeveloper", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + quotaLimitApproachingDeveloperNotificationMessage: "quotaLimitApproachingDeveloperNotificationMessage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + newDeveloperNotificationMessage: "newDeveloperNotificationMessage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + emailChangeIdentityDefault: "emailChangeIdentityDefault", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + inviteUserNotificationMessage: "inviteUserNotificationMessage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + newCommentNotificationMessage: "newCommentNotificationMessage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + confirmSignUpIdentityDefault: "confirmSignUpIdentityDefault", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + newIssueNotificationMessage: "newIssueNotificationMessage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + purchaseDeveloperNotificationMessage: "purchaseDeveloperNotificationMessage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + passwordResetIdentityDefault: "passwordResetIdentityDefault", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + passwordResetByAdminNotificationMessage: "passwordResetByAdminNotificationMessage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + rejectDeveloperNotificationMessage: "rejectDeveloperNotificationMessage", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + requestDeveloperNotificationMessage: "requestDeveloperNotificationMessage", +} + +/** + * Purpose of debug credential. + */ +union GatewayListDebugCredentialsContractPurpose { + string, + + /** + * The tracing purpose. + */ + tracing: "tracing", +} + +/** + * Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. + */ +union UserState { + string, + + /** + * User state is active. + */ + active: "active", + + /** + * User is blocked. Blocked users cannot authenticate at developer portal or call API. + */ + blocked: "blocked", + + /** + * User account is pending. Requires identity confirmation before it can be made active. + */ + pending: "pending", + + /** + * User account is closed. All identities and related entities are removed. + */ + deleted: "deleted", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union IdentityProviderType { + string, + + /** + * Facebook as Identity provider. + */ + facebook: "facebook", + + /** + * Google as Identity provider. + */ + google: "google", + + /** + * Microsoft Live as Identity provider. + */ + microsoft: "microsoft", + + /** + * Twitter as Identity provider. + */ + twitter: "twitter", + + /** + * Azure Active Directory as Identity provider. + */ + aad: "aad", + + /** + * Azure Active Directory B2C as Identity provider. + */ + aadB2C: "aadB2C", +} + +/** + * Logger type. + */ +union LoggerType { + string, + + /** + * Azure Event Hub as log destination. + */ + azureEventHub: "azureEventHub", + + /** + * Azure Application Insights as log destination. + */ + applicationInsights: "applicationInsights", + + /** + * Azure Monitor + */ + azureMonitor: "azureMonitor", +} + +/** + * Resource Connectivity Status Type identifier. + */ +union ConnectivityStatusType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + initializing: "initializing", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + success: "success", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + failure: "failure", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union NotificationName { + string, + + /** + * The following email recipients and users will receive email notifications about subscription requests for API products requiring approval. + */ + RequestPublisherNotificationMessage: "RequestPublisherNotificationMessage", + + /** + * The following email recipients and users will receive email notifications about new API product subscriptions. + */ + PurchasePublisherNotificationMessage: "PurchasePublisherNotificationMessage", + + /** + * The following email recipients and users will receive email notifications when new applications are submitted to the application gallery. + */ + NewApplicationNotificationMessage: "NewApplicationNotificationMessage", + + /** + * The following recipients will receive blind carbon copies of all emails sent to developers. + */ + BCC: "BCC", + + /** + * The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal. + */ + NewIssuePublisherNotificationMessage: "NewIssuePublisherNotificationMessage", + + /** + * The following email recipients and users will receive email notifications when developer closes his account. + */ + AccountClosedPublisher: "AccountClosedPublisher", + + /** + * The following email recipients and users will receive email notifications when subscription usage gets close to usage quota. + */ + QuotaLimitApproachingPublisherNotificationMessage: "QuotaLimitApproachingPublisherNotificationMessage", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union PolicyFragmentContentFormat { + string, + + /** + * The contents are inline and Content type is an XML document. + */ + xml: "xml", + + /** + * The contents are inline and Content type is a non XML encoded policy document. + */ + rawxml: "rawxml", +} + +/** + * Indicates if base policy should be enforced for the policy document. + */ +union PolicyRestrictionRequireBase { + string, + + /** + * The policy is required to have base policy + */ + `true`: "true", + + /** + * The policy does not require to have base policy + */ + `false`: "false", +} + +/** + * The mode of the developer portal Content Security Policy (CSP). + */ +union PortalSettingsCspMode { + string, + + /** + * The browser will block requests not matching allowed origins. + */ + enabled: "enabled", + + /** + * The browser will not apply the origin restrictions. + */ + disabled: "disabled", + + /** + * The browser will report requests not matching allowed origins without blocking them. + */ + reportOnly: "reportOnly", +} + +/** + * Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks. + */ +union ClientApplicationState { + string, + + /** + * If there are no associated ClientApplicationLinks or all ClientApplicationLinks are in a state that doesn't meet the criteria for the states: active, rejected, approved (e.g., a mix of active and rejected without any approved). + */ + pending: "pending", + + /** + * If there are no approved ClientApplicationLink, but at least one ClientApplicationLink is active, the Application is considered active + */ + active: "active", + + /** + * If all ClientApplicationLinks are rejected, the Application is considered rejected + */ + rejected: "rejected", + + /** + * If at least one ClientApplicationLink is approved, the Application is considered approved + */ + approved: "approved", +} + +/** + * Status of the portal's revision. + */ +union PortalRevisionStatus { + string, + + /** + * Portal's revision has been queued. + */ + pending: "pending", + + /** + * Portal's revision is being published. + */ + publishing: "publishing", + + /** + * Portal's revision publishing completed. + */ + completed: "completed", + + /** + * Portal's revision publishing failed. + */ + failed: "failed", +} + +/** + * Schema Type. Immutable. + */ +union SchemaType { + string, + + /** + * XML schema type. + */ + Xml: "xml", + + /** + * Json schema type. + */ + Json: "json", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union SettingsTypeName { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + public: "public", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union AppType { + string, + + /** + * User create request was sent by legacy developer portal. + */ + portal: "portal", + + /** + * User create request was sent by new developer portal. + */ + developerPortal: "developerPortal", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union AccessIdName { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + access: "access", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + gitAccess: "gitAccess", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union ConfigurationIdName { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + configuration: "configuration", +} + +/** + * Determines the type of confirmation e-mail that will be sent to the newly created user. + */ +union Confirmation { + string, + + /** + * Send an e-mail to the user confirming they have successfully signed up. + */ + signup: "signup", + + /** + * Send an e-mail inviting the user to sign-up and complete registration. + */ + invite: "invite", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union KeyVaultRefreshState { + string, + + /** + * Entities for which KeyVault refresh failed. + */ + `true`: "true", + + /** + * Entities for which KeyVault refresh succeeded + */ + `false`: "false", +} + +/** + * whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. + */ +#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +enum ProductState { + notPublished, + published, +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +enum AuthorizationMethod { + HEAD, + OPTIONS, + TRACE, + GET, + POST, + PUT, + PATCH, + DELETE, +} + +/** + * Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable. + */ +#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +enum NameAvailabilityReason { + Valid, + Invalid, + AlreadyExists, +} + +/** + * The Key to be used to generate token for user. + */ +#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +enum KeyType { + primary, + secondary, +} + +/** + * Group type. + */ +#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +enum GroupType { + custom, + system, + external, +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +enum PolicyScopeContract { + Tenant, + Product, + Api, + Operation, + All, +} + +/** + * Status of an async operation. + */ +#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +enum AsyncOperationStatus { + Started, + InProgress, + Succeeded, + Failed, +} + +/** + * Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. + */ +#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +enum SubscriptionState { + suspended, + active, + expired, + submitted, + rejected, + cancelled, +} + +/** + * The scale type applicable to the sku. + */ +#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +enum ApiManagementSkuCapacityScaleType { + Automatic, + Manual, + None, +} + +/** + * The type of restrictions. + */ +#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +enum ApiManagementSkuRestrictionsType { + Location, + Zone, +} + +/** + * The reason for restriction. + */ +#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +enum ApiManagementSkuRestrictionsReasonCode { + QuotaId, + NotAvailableForSubscription, +} + +/** + * Status of an async resolver. + */ +#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +enum AsyncResolverStatus { + Started, + InProgress, + Succeeded, + Failed, +} + +/** + * Properties of an API Management gateway resource description. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiManagementGatewayProperties + extends ApiManagementGatewayBaseProperties {} + +/** + * Base Properties of an API Management gateway resource description. + */ +model ApiManagementGatewayBaseProperties { + /** + * The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + provisioningState?: string; + + /** + * The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway. + */ + @visibility(Lifecycle.Read) + targetProvisioningState?: string; + + /** + * Creation UTC date of the API Management gateway.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + createdAtUtc?: utcDateTime; + + /** + * Information regarding how the gateway should be exposed. + */ + frontend?: FrontendConfiguration; + + /** + * Information regarding how the gateway should integrate with backend systems. + */ + backend?: BackendConfiguration; + + /** + * Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU. + */ + configurationApi?: GatewayConfigurationApi; + + /** + * The type of VPN in which API Management gateway needs to be configured in. + */ + virtualNetworkType?: VirtualNetworkType; +} + +/** + * Information regarding how the gateway should be exposed. + */ +model FrontendConfiguration { + /** + * The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU. + */ + @visibility(Lifecycle.Read) + defaultHostname?: string; +} + +/** + * Information regarding how the gateway should integrate with backend systems. + */ +model BackendConfiguration { + /** + * The default hostname of the data-plane gateway to which requests can be sent. + */ + subnet?: BackendSubnetConfiguration; +} + +/** + * Information regarding how the subnet to which the gateway should be injected. + */ +model BackendSubnetConfiguration { + /** + * The ARM ID of the subnet in which the backend systems are hosted. + */ + id?: string; +} + +/** + * Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU. + */ +model GatewayConfigurationApi { + /** + * Hostname to which the agent connects to propagate configuration to the cloud. + */ + @visibility(Lifecycle.Read) + hostname?: string; +} + +/** + * API Management gateway resource SKU properties. + */ +model ApiManagementGatewaySkuProperties { + /** + * Name of the Sku. + */ + name: ApiGatewaySkuType; + + /** + * Capacity of the SKU (number of deployed units of the SKU) + */ + capacity?: int32; +} + +/** + * The Resource definition. + */ +model ApimResource { + /** + * Resource ID. + */ + @visibility(Lifecycle.Read) + id?: string; + + /** + * Resource name. + */ + @visibility(Lifecycle.Read) + name?: string; + + /** + * Resource type for API Management resource is set to Microsoft.ApiManagement. + */ + @visibility(Lifecycle.Read) + type?: string; + + /** + * Resource tags. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; +} + +/** + * Parameter supplied to Update API Management gateway. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiManagementGatewayUpdateParameters extends ApimResource { + /** + * Properties of the API Management gateway. + */ + properties?: ApiManagementGatewayUpdateProperties; + + /** + * SKU properties of the API Management gateway. + */ + sku?: ApiManagementGatewaySkuPropertiesForPatch; + + /** + * ETag of the resource. + */ + @visibility(Lifecycle.Read) + etag?: string; +} + +/** + * Properties of an API Management gateway resource description. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiManagementGatewayUpdateProperties + extends ApiManagementGatewayBaseProperties {} + +/** + * API Management gateway resource SKU properties for PATCH operations given nothing should be required. + */ +model ApiManagementGatewaySkuPropertiesForPatch { + /** + * Name of the Sku. + */ + name?: ApiGatewaySkuType; + + /** + * Capacity of the SKU (number of deployed units of the SKU) + */ + capacity?: int32; +} + +/** + * The API Management gateway SKUs operation response. + */ +model GatewayResourceSkuResults { + /** + * The list of skus available for the gateway. + */ + @pageItems + @OpenAPI.extension("x-ms-identifiers", #["resourceType", "sku/name"]) + value: GatewayResourceSkuResult[]; + + /** + * The uri to fetch the next page of API Management gateway Skus. + */ + @nextLink + nextLink?: string; +} + +/** + * Describes an available API Management gateway SKU. + */ +model GatewayResourceSkuResult { + /** + * The type of resource the SKU applies to. + */ + @visibility(Lifecycle.Read) + resourceType?: string; + + /** + * Specifies API Management gateway SKU. + */ + @visibility(Lifecycle.Read) + sku?: GatewaySku; + + /** + * Specifies the number of API Management gateway units. + */ + @visibility(Lifecycle.Read) + capacity?: GatewaySkuCapacity; +} + +/** + * Describes an available API Management SKU for gateways. + */ +model GatewaySku { + /** + * Name of the Sku. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @OpenAPI.externalDocs("https://azure.microsoft.com/en-us/pricing/details/api-management/") + name?: ApiGatewaySkuType; +} + +/** + * Describes scaling information of a SKU. + */ +model GatewaySkuCapacity { + /** + * The minimum capacity. + */ + @visibility(Lifecycle.Read) + minimum?: int32; + + /** + * The maximum capacity that can be set. + */ + @visibility(Lifecycle.Read) + maximum?: int32; + + /** + * The default capacity. + */ + @visibility(Lifecycle.Read) + default?: int32; + + /** + * The scale type applicable to the sku. + */ + @visibility(Lifecycle.Read) + scaleType?: GatewaySkuCapacityScaleType; +} + +/** + * The response of All Policies. + */ +model AllPoliciesCollection { + /** + * AllPolicies Contract value. + */ + @pageItems + value?: AllPoliciesContract[]; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * AllPolicies Contract details. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AllPoliciesContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Properties of the All Policies. + */ + properties?: AllPoliciesContractProperties; +} + +/** + * AllPolicies Properties. + */ +model AllPoliciesContractProperties { + /** + * Policy Identifier + */ + referencePolicyId?: string; + + /** + * Policy Restriction Compliance State + */ + complianceState?: PolicyComplianceState = PolicyComplianceState.Pending; +} + +/** + * Paged API list representation. + */ +model ApiCollection { + /** + * Page values. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: ApiContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * API Entity Properties + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiContractProperties extends ApiEntityBaseContract { + /** + * API identifier of the source API. + */ + sourceApiId?: string; + + /** + * API name. Must be 1 to 300 characters long. + */ + @maxLength(300) + @minLength(1) + displayName?: string; + + /** + * Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. + */ + @maxLength(2000) + @minLength(0) + serviceUrl?: string; + + /** + * Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. + */ + @maxLength(400) + @minLength(0) + path: string; + + /** + * Describes on which protocols the operations in this API can be invoked. + */ + protocols?: Protocol[]; + + /** + * Version set details + */ + apiVersionSet?: ApiVersionSetContractDetails; + + /** + * The provisioning state + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + provisioningState?: string; +} + +/** + * An API Version Set contains the common configuration for a set of API Versions relating + */ +model ApiVersionSetContractDetails { + /** + * Identifier for existing API Version Set. Omit this value to create a new Version Set. + */ + id?: string; + + /** + * The display Name of the API Version Set. + */ + name?: string; + + /** + * Description of API Version Set. + */ + description?: string; + + /** + * An value that determines where the API Version identifier will be located in a HTTP request. + */ + versioningScheme?: VersioningScheme; + + /** + * Name of query parameter that indicates the API Version if versioningScheme is set to `query`. + */ + versionQueryName?: string; + + /** + * Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. + */ + versionHeaderName?: string; +} + +/** + * API base contract details. + */ +model ApiEntityBaseContract { + /** + * Description of the API. May include HTML formatting tags. + */ + description?: string; + + /** + * Collection of authentication settings included into this API. + */ + authenticationSettings?: AuthenticationSettingsContract; + + /** + * Protocols over which API is made available. + */ + subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract; + + /** + * Type of API. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + type?: ApiType; + + /** + * Describes the revision of the API. If no value is provided, default revision 1 is created + */ + @maxLength(100) + @minLength(1) + apiRevision?: string; + + /** + * Indicates the version identifier of the API if the API is versioned + */ + @maxLength(100) + apiVersion?: string; + + /** + * Indicates if API revision is current api revision. + */ + isCurrent?: boolean; + + /** + * Indicates if API revision is accessible via the gateway. + */ + @visibility(Lifecycle.Read) + isOnline?: boolean; + + /** + * Description of the API Revision. + */ + @maxLength(256) + apiRevisionDescription?: string; + + /** + * Description of the API Version. + */ + @maxLength(256) + apiVersionDescription?: string; + + /** + * A resource identifier for the related ApiVersionSet. + */ + apiVersionSetId?: string; + + /** + * Specifies whether an API or Product subscription is required for accessing the API. + */ + subscriptionRequired?: boolean; + + /** + * A URL to the Terms of Service for the API. MUST be in the format of a URL. + */ + termsOfServiceUrl?: string; + + /** + * Contact information for the API. + */ + contact?: ApiContactInformation; + + /** + * License information for the API. + */ + license?: ApiLicenseInformation; +} + +/** + * API Authentication Settings. + */ +model AuthenticationSettingsContract { + /** + * OAuth2 Authentication settings + */ + oAuth2?: OAuth2AuthenticationSettingsContract; + + /** + * OpenID Connect Authentication Settings + */ + openid?: OpenIdAuthenticationSettingsContract; + + /** + * Collection of OAuth2 authentication settings included into this API. + */ + @OpenAPI.extension("x-ms-identifiers", #["authorizationServerId"]) + oAuth2AuthenticationSettings?: OAuth2AuthenticationSettingsContract[]; + + /** + * Collection of Open ID Connect authentication settings included into this API. + */ + @OpenAPI.extension("x-ms-identifiers", #["openidProviderId"]) + openidAuthenticationSettings?: OpenIdAuthenticationSettingsContract[]; +} + +/** + * API OAuth2 Authentication settings details. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model OAuth2AuthenticationSettingsContract { + /** + * OAuth authorization server identifier. + */ + authorizationServerId?: string; + + /** + * operations scope. + */ + scope?: string; +} + +/** + * API OAuth2 Authentication settings details. + */ +model OpenIdAuthenticationSettingsContract { + /** + * OAuth authorization server identifier. + */ + openidProviderId?: string; + + /** + * How to send token to the server. + */ + bearerTokenSendingMethods?: BearerTokenSendingMethods[]; +} + +/** + * Subscription key parameter names details. + */ +model SubscriptionKeyParameterNamesContract { + /** + * Subscription key header name. + */ + header?: string; + + /** + * Subscription key query string parameter name. + */ + query?: string; +} + +/** + * API contact information + */ +model ApiContactInformation { + /** + * The identifying name of the contact person/organization + */ + name?: string; + + /** + * The URL pointing to the contact information. MUST be in the format of a URL + */ + url?: string; + + /** + * The email address of the contact person/organization. MUST be in the format of an email address + */ + email?: string; +} + +/** + * API license information + */ +model ApiLicenseInformation { + /** + * The license name used for the API + */ + name?: string; + + /** + * A URL to the license used for the API. MUST be in the format of a URL + */ + url?: string; +} + +/** + * API Create or Update Parameters. + */ +model ApiCreateOrUpdateParameter { + /** + * API entity create of update properties. + */ + properties?: ApiCreateOrUpdateProperties; +} + +/** + * API Create or Update Properties. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiCreateOrUpdateProperties extends ApiContractProperties { + /** + * Content value when Importing an API. + */ + value?: string; + + /** + * Format of the Content in which the API is getting imported. New formats can be added in the future + */ + format?: ContentFormat; + + /** + * Criteria to limit import of WSDL to a subset of the document. + */ + wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector; + + /** + * Type of API to create. + * * `http` creates a REST API + * * `soap` creates a SOAP pass-through API + * * `websocket` creates websocket API + * * `graphql` creates GraphQL API. + * New types can be added in the future. + */ + apiType?: SoapApiType; + + /** + * Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query' + */ + translateRequiredQueryParameters?: TranslateRequiredQueryParametersConduct; +} + +/** + * Criteria to limit import of WSDL to a subset of the document. + */ +model ApiCreateOrUpdatePropertiesWsdlSelector { + /** + * Name of service to import from WSDL + */ + wsdlServiceName?: string; + + /** + * Name of endpoint(port) to import from WSDL + */ + wsdlEndpointName?: string; +} + +/** + * API update contract details. + */ +model ApiUpdateContract { + /** + * Properties of the API entity that can be updated. + */ + properties?: ApiContractUpdateProperties; +} + +/** + * API update contract properties. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiContractUpdateProperties extends ApiEntityBaseContract { + /** + * API name. + */ + @maxLength(300) + @minLength(1) + displayName?: string; + + /** + * Absolute URL of the backend service implementing this API. + */ + @maxLength(2000) + @minLength(1) + serviceUrl?: string; + + /** + * Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. + */ + @maxLength(400) + @minLength(0) + path?: string; + + /** + * Describes on which protocols the operations in this API can be invoked. + */ + protocols?: Protocol[]; +} + +/** + * Paged API Revision list representation. + */ +model ApiRevisionCollection { + /** + * Page values. + */ + @pageItems + @visibility(Lifecycle.Read) + @OpenAPI.extension("x-ms-identifiers", #["apiId"]) + value?: ApiRevisionContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * Summary of revision metadata. + */ +model ApiRevisionContract { + /** + * Identifier of the API Revision. + */ + @visibility(Lifecycle.Read) + apiId?: string; + + /** + * Revision number of API. + */ + @visibility(Lifecycle.Read) + @maxLength(100) + @minLength(1) + apiRevision?: string; + + /** + * The time the API Revision was created. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + createdDateTime?: utcDateTime; + + /** + * The time the API Revision were updated. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + updatedDateTime?: utcDateTime; + + /** + * Description of the API Revision. + */ + @visibility(Lifecycle.Read) + @maxLength(256) + description?: string; + + /** + * Gateway URL for accessing the non-current API Revision. + */ + @visibility(Lifecycle.Read) + privateUrl?: string; + + /** + * Indicates if API revision is the current api revision. + */ + @visibility(Lifecycle.Read) + isOnline?: boolean; + + /** + * Indicates if API revision is accessible via the gateway. + */ + @visibility(Lifecycle.Read) + isCurrent?: boolean; +} + +/** + * Paged ApiRelease list representation. + */ +model ApiReleaseCollection { + /** + * Page values. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: ApiReleaseContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} +/** + * API Release details + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiReleaseContractProperties { + /** + * Identifier of the API the release belongs to. + */ + apiId?: string; + + /** + * The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + createdDateTime?: utcDateTime; + + /** + * The time the API release was updated. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + updatedDateTime?: utcDateTime; + + /** + * Release Notes + */ + notes?: string; +} + +/** + * Paged Operation list representation. + */ +model OperationCollection { + /** + * Page values. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: OperationContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} +/** + * Operation Contract Properties + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model OperationContractProperties extends OperationEntityBaseContract { + /** + * Operation Name. + */ + @maxLength(300) + @minLength(1) + displayName: string; + + /** + * A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @OpenAPI.externalDocs( + "http://www.rfc-editor.org/rfc/rfc7230.txt", + "As defined by RFC." + ) + method: string; + + /** + * Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + */ + @maxLength(1000) + @minLength(1) + urlTemplate: string; +} + +/** + * API Operation Entity Base Contract details. + */ +model OperationEntityBaseContract { + /** + * Collection of URL template parameters. + */ + @OpenAPI.extension("x-ms-identifiers", #["name", "type"]) + templateParameters?: ParameterContract[]; + + /** + * Description of the operation. May include HTML formatting tags. + */ + @maxLength(1000) + description?: string; + + /** + * An entity containing request details. + */ + request?: RequestContract; + + /** + * Array of Operation responses. + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + responses?: ResponseContract[]; + + /** + * Operation Policies + */ + policies?: string; +} + +/** + * Operation parameters details. + */ +model ParameterContract { + /** + * Parameter name. + */ + name: string; + + /** + * Parameter description. + */ + description?: string; + + /** + * Parameter type. + */ + type: string; + + /** + * Default parameter value. + */ + defaultValue?: string; + + /** + * Specifies whether parameter is required or not. + */ + required?: boolean; + + /** + * Parameter values. + */ + values?: string[]; + + /** + * Schema identifier. + */ + schemaId?: string; + + /** + * Type name defined by the schema. + */ + typeName?: string; + + /** + * Exampled defined for the parameter. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + examples?: Record; +} + +/** + * Parameter example. + */ +model ParameterExampleContract { + /** + * Short description for the example + */ + summary?: string; + + /** + * Long description for the example + */ + description?: string; + + /** + * Example value. May be a primitive value, or an object. + */ + #suppress "@azure-tools/typespec-azure-core/no-unknown" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + value?: unknown; + + /** + * A URL that points to the literal example + */ + externalValue?: string; +} + +/** + * Operation request details. + */ +model RequestContract { + /** + * Operation request description. + */ + description?: string; + + /** + * Collection of operation request query parameters. + */ + @OpenAPI.extension("x-ms-identifiers", #["name", "type"]) + queryParameters?: ParameterContract[]; + + /** + * Collection of operation request headers. + */ + @OpenAPI.extension("x-ms-identifiers", #["name", "type"]) + headers?: ParameterContract[]; + + /** + * Collection of operation request representations. + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + representations?: RepresentationContract[]; +} + +/** + * Operation request/response representation details. + */ +model RepresentationContract { + /** + * Specifies a registered or custom content type for this representation, e.g. application/xml. + */ + contentType: string; + + /** + * Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. + */ + schemaId?: string; + + /** + * Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. + */ + typeName?: string; + + /** + * Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. + */ + @OpenAPI.extension("x-ms-identifiers", #["name", "type"]) + formParameters?: ParameterContract[]; + + /** + * Exampled defined for the representation. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + examples?: Record; +} + +/** + * Operation response details. + */ +model ResponseContract { + /** + * Operation response HTTP status code. + */ + statusCode: int32; + + /** + * Operation response description. + */ + description?: string; + + /** + * Collection of operation response representations. + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + representations?: RepresentationContract[]; + + /** + * Collection of operation response headers. + */ + @OpenAPI.extension("x-ms-identifiers", #["name", "type"]) + headers?: ParameterContract[]; +} + +/** + * API Operation Update Contract details. + */ +model OperationUpdateContract { + /** + * Properties of the API Operation entity that can be updated. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @OpenAPI.externalDocs( + "http://www.rfc-editor.org/rfc/rfc7230.txt", + "As defined by RFC." + ) + properties?: OperationUpdateContractProperties; +} + +/** + * Operation Update Contract Properties. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model OperationUpdateContractProperties extends OperationEntityBaseContract { + /** + * Operation Name. + */ + @maxLength(300) + @minLength(1) + displayName?: string; + + /** + * A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. + */ + method?: string; + + /** + * Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + */ + @maxLength(1000) + @minLength(1) + urlTemplate?: string; +} + +/** + * The response of the list policy operation. + */ +model PolicyCollection { + /** + * Policy Contract value. + */ + @pageItems + value?: PolicyContract[]; + + /** + * Total record count number. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Policy contract Properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PolicyContractProperties { + /** + * Contents of the Policy as defined by the format. + */ + value: string; + + /** + * Format of the policyContent. + */ + format?: PolicyContentFormat = PolicyContentFormat.xml; +} + +/** + * Paged Tag list representation. + */ +model TagCollection { + /** + * Page values. + */ + @pageItems + value?: TagContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Tag contract Properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TagContractProperties { + /** + * Tag name. + */ + @maxLength(160) + @minLength(1) + displayName: string; +} + +/** + * Paged Resolver list representation. + */ +model ResolverCollection { + /** + * Page values. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: ResolverContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * GraphQL API Resolver Entity Base Contract details. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ResolverEntityBaseContract { + /** + * Resolver Name. + */ + @maxLength(300) + @minLength(1) + displayName?: string; + + /** + * Path is type/field being resolved. + */ + @maxLength(300) + @minLength(1) + path?: string; + + /** + * Description of the resolver. May include HTML formatting tags. + */ + @maxLength(1000) + description?: string; +} + +/** + * GraphQL API Resolver Update Contract details. + */ +model ResolverUpdateContract { + /** + * Properties of the GraphQL API Resolver entity that can be updated. + */ + properties?: ResolverUpdateContractProperties; +} + +/** + * Resolver Update Contract Properties. + */ +model ResolverUpdateContractProperties { + /** + * Resolver Name. + */ + @maxLength(300) + @minLength(1) + displayName?: string; + + /** + * Path is type/field being resolved. + */ + @maxLength(300) + @minLength(1) + path?: string; + + /** + * Description of the resolver. May include HTML formatting tags. + */ + @maxLength(1000) + description?: string; +} + +/** + * Paged Products list representation. + */ +model ProductCollection { + /** + * Page values. + */ + @pageItems + value?: ProductContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Product profile. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ProductContractProperties extends ProductEntityBaseParameters { + /** + * Product name. + */ + @maxLength(300) + @minLength(1) + displayName: string; +} + +/** + * Product Entity Base Parameters + */ +model ProductEntityBaseParameters { + /** + * Product description. May include HTML formatting tags. + */ + @maxLength(1000) + @minLength(0) + description?: string; + + /** + * Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. + */ + terms?: string; + + /** + * Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. + */ + subscriptionRequired?: boolean; + + /** + * whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false. + */ + approvalRequired?: boolean; + + /** + * Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false. + */ + subscriptionsLimit?: int32; + + /** + * Type of supported authentication for the product. The application configuration is required for application-token authentication type. The subscription-key authentication type is used by default. If the property is omitted, the subscription-key authentication type is used. + */ + authenticationType?: ProductAuthType[]; + + /** + * Specifies identity provider settings needed to authorize applications API calls. + */ + application?: ProductEntityBaseParametersApplication; + + /** + * whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. + */ + state?: ProductState; +} + +/** + * Specifies identity provider settings needed to authorize applications API calls. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ProductEntityBaseParametersApplication + extends ProductApplicationContract {} + +/** + * Specifies Microsoft Entra settings needed to authorize product API calls using client applications. + */ +model ProductApplicationContract { + /** + * Specifies Microsoft Entra settings needed to authorize product API calls using client application with Microsoft Entra OAuth token. + */ + entra?: ProductApplicationContractEntra; +} + +/** + * Specifies Microsoft Entra settings needed to authorize product API calls using client application with Microsoft Entra OAuth token. + */ +model ProductApplicationContractEntra { + /** + * Product facing EntraID application client ID. + */ + applicationId?: string; + + /** + * The EntraID application audience claim. The audience claim is used to validate the token. + */ + audience?: string; +} + +/** + * The response of the list schema operation. + */ +model SchemaCollection { + /** + * API Schema Contract value. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: SchemaContract[]; + + /** + * Total record count number. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} +/** + * API Schema create or update contract Properties. + */ +model SchemaContractProperties { + /** + * Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`. + */ + contentType: string; + + /** + * Create or update Properties of the API Schema Document. + */ + document: SchemaDocumentProperties; + + /** + * The provisioning state + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + provisioningState?: string; +} + +/** + * Api Schema Document Properties. + */ +model SchemaDocumentProperties { + /** + * Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. + */ + value?: string; + + /** + * Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise. + */ + #suppress "@azure-tools/typespec-azure-core/no-unknown" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + definitions?: unknown; + + /** + * Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise. + */ + #suppress "@azure-tools/typespec-azure-core/no-unknown" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + components?: unknown; +} + +/** + * Paged Diagnostic list representation. + */ +model DiagnosticCollection { + /** + * Page values. + */ + @pageItems + value?: DiagnosticContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Diagnostic Entity Properties + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model DiagnosticContractProperties { + /** + * Specifies for what type of messages sampling settings should not apply. + */ + alwaysLog?: AlwaysLog; + + /** + * Resource Id of a target logger. + */ + loggerId: string; + + /** + * Sampling settings for Diagnostic. + */ + sampling?: SamplingSettings; + + /** + * Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. + */ + frontend?: PipelineDiagnosticSettings; + + /** + * Diagnostic settings for incoming/outgoing HTTP messages to the Backend + */ + backend?: PipelineDiagnosticSettings; + + /** + * Large Language Models diagnostic settings + */ + largeLanguageModel?: LLMDiagnosticSettings; + + /** + * Log the ClientIP. Default is false. + */ + logClientIp?: boolean; + + /** + * Sets correlation protocol to use for Application Insights diagnostics. + */ + httpCorrelationProtocol?: HttpCorrelationProtocol; + + /** + * The verbosity level applied to traces emitted by trace policies. + */ + verbosity?: Verbosity; + + /** + * The format of the Operation Name for Application Insights telemetries. Default is Name. + */ + operationNameFormat?: OperationNameFormat; + + /** + * Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. + */ + metrics?: boolean; +} + +/** + * Sampling settings for Diagnostic. + */ +model SamplingSettings { + /** + * Sampling type. + */ + samplingType?: SamplingType; + + /** + * Rate of sampling for fixed-rate sampling. + */ + @maxValue(100) + @minValue(0) + percentage?: float64; +} + +/** + * Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. + */ +model PipelineDiagnosticSettings { + /** + * Diagnostic settings for request. + */ + request?: HttpMessageDiagnostic; + + /** + * Diagnostic settings for response. + */ + response?: HttpMessageDiagnostic; +} + +/** + * Http message diagnostic settings. + */ +model HttpMessageDiagnostic { + /** + * Array of HTTP Headers to log. + */ + headers?: string[]; + + /** + * Body logging settings. + */ + body?: BodyDiagnosticSettings; + + /** + * Data masking settings. + */ + dataMasking?: DataMasking; +} + +/** + * Body logging settings. + */ +model BodyDiagnosticSettings { + /** + * Number of request body bytes to log. + */ + @maxValue(8192) + bytes?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model DataMasking { + /** + * Masking settings for Url query parameters + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + queryParams?: DataMaskingEntity[]; + + /** + * Masking settings for headers + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + headers?: DataMaskingEntity[]; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model DataMaskingEntity { + /** + * The name of an entity to mask (e.g. a name of a header or a query parameter). + */ + value?: string; + + /** + * Data masking mode. + */ + mode?: DataMaskingMode; +} + +/** + * Diagnostic settings for Large Language Models + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model LLMDiagnosticSettings { + /** + * Specifies whether default diagnostic should be enabled for Large Language Models or not. + */ + logs?: LlmDiagnosticSettings; + + /** + * Diagnostic settings for Large Language Models requests. + */ + requests?: LLMMessageDiagnosticSettings; + + /** + * Diagnostic settings for Large Language Models responses. + */ + responses?: LLMMessageDiagnosticSettings; +} + +/** + * Diagnostic settings for Large Language Models Messages + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model LLMMessageDiagnosticSettings { + /** + * Specifies which message should be logged. Currently there is only 'all' option. + */ + messages?: LlmMessageLogTypes; + + /** + * Maximum size of message to logs in bytes. The default size is 32KB. + */ + @maxValue(262144) + @minValue(1) + maxSizeInBytes?: int32; +} + +/** + * Paged Issue list representation. + */ +model IssueCollection { + /** + * Issue values. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: IssueContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} +/** + * Issue contract Properties. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model IssueContractProperties extends IssueContractBaseProperties { + /** + * The issue title. + */ + title: string; + + /** + * Text describing the issue. + */ + description: string; + + /** + * A resource identifier for the user created the issue. + */ + userId: string; +} + +/** + * Issue contract Base Properties. + */ +model IssueContractBaseProperties { + /** + * Date and time when the issue was created. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + createdDate?: utcDateTime; + + /** + * Status of the issue. + */ + state?: State; + + /** + * A resource identifier for the API the issue was created for. + */ + apiId?: string; +} + +/** + * Issue update Parameters. + */ +model IssueUpdateContract { + /** + * Issue entity Update contract properties. + */ + properties?: IssueUpdateContractProperties; +} + +/** + * Issue contract Update Properties. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model IssueUpdateContractProperties extends IssueContractBaseProperties { + /** + * The issue title. + */ + title?: string; + + /** + * Text describing the issue. + */ + description?: string; + + /** + * A resource identifier for the user created the issue. + */ + userId?: string; +} + +/** + * Paged Issue Comment list representation. + */ +model IssueCommentCollection { + /** + * Issue Comment values. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: IssueCommentContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * Issue Comment contract Properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model IssueCommentContractProperties { + /** + * Comment text. + */ + text: string; + + /** + * Date and time when the comment was created. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + createdDate?: utcDateTime; + + /** + * A resource identifier for the user who left the comment. + */ + userId: string; +} + +/** + * Paged Issue Attachment list representation. + */ +model IssueAttachmentCollection { + /** + * Issue Attachment values. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: IssueAttachmentContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * Issue Attachment contract Properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model IssueAttachmentContractProperties { + /** + * Filename by which the binary data will be saved. + */ + title: string; + + /** + * Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property. + */ + contentFormat: string; + + /** + * An HTTP link or Base64-encoded binary data. + */ + content: string; +} + +/** + * Paged TagDescription list representation. + */ +model TagDescriptionCollection { + /** + * Page values. + */ + @pageItems + value?: TagDescriptionContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * TagDescription contract Properties. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TagDescriptionContractProperties extends TagDescriptionBaseProperties { + /** + * Identifier of the tag in the form of /tags/{tagId} + */ + tagId?: string; + + /** + * Tag name. + */ + @maxLength(160) + @minLength(1) + displayName?: string; +} + +/** + * Parameters supplied to the Create TagDescription operation. + */ +model TagDescriptionBaseProperties { + /** + * Description of the Tag. + */ + description?: string; + + /** + * Absolute URL of external resources describing the tag. + */ + @maxLength(2000) + externalDocsUrl?: string; + + /** + * Description of the external resources describing the tag. + */ + externalDocsDescription?: string; +} + +/** + * Parameters supplied to the Create TagDescription operation. + */ +model TagDescriptionCreateParameters { + /** + * Properties supplied to Create TagDescription operation. + */ + properties?: TagDescriptionBaseProperties; +} + +/** + * Paged Tag list representation. + */ +model TagResourceCollection { + /** + * Page values. + */ + @pageItems + @OpenAPI.extension("x-ms-identifiers", #["tag/id"]) + value?: TagResourceContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * TagResource contract properties. + */ +model TagResourceContract { + /** + * Tag associated with the resource. + */ + tag: TagTagResourceContractProperties; + + /** + * API associated with the tag. + */ + api?: ApiTagResourceContractProperties; + + /** + * Operation associated with the tag. + */ + operation?: OperationTagResourceContractProperties; + + /** + * Product associated with the tag. + */ + product?: ProductTagResourceContractProperties; +} + +/** + * Contract defining the Tag property in the Tag Resource Contract + */ +model TagTagResourceContractProperties { + /** + * Tag identifier + */ + id?: string; + + /** + * Tag Name + */ + @maxLength(160) + @minLength(1) + name?: string; +} + +/** + * API contract properties for the Tag Resources. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiTagResourceContractProperties extends ApiEntityBaseContract { + /** + * API identifier in the form /apis/{apiId}. + */ + id?: string; + + /** + * API name. + */ + @maxLength(300) + @minLength(1) + name?: string; + + /** + * Absolute URL of the backend service implementing this API. + */ + @maxLength(2000) + @minLength(1) + serviceUrl?: string; + + /** + * Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. + */ + @maxLength(400) + @minLength(0) + path?: string; + + /** + * Describes on which protocols the operations in this API can be invoked. + */ + protocols?: Protocol[]; +} + +/** + * Operation Entity contract Properties. + */ +model OperationTagResourceContractProperties { + /** + * Identifier of the operation in form /operations/{operationId}. + */ + id?: string; + + /** + * Operation name. + */ + @visibility(Lifecycle.Read) + name?: string; + + /** + * API Name. + */ + @visibility(Lifecycle.Read) + apiName?: string; + + /** + * API Revision. + */ + @visibility(Lifecycle.Read) + apiRevision?: string; + + /** + * API Version. + */ + @visibility(Lifecycle.Read) + apiVersion?: string; + + /** + * Operation Description. + */ + @visibility(Lifecycle.Read) + description?: string; + + /** + * A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + @OpenAPI.externalDocs( + "http://www.rfc-editor.org/rfc/rfc7230.txt", + "As defined by RFC." + ) + method?: string; + + /** + * Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + */ + @visibility(Lifecycle.Read) + urlTemplate?: string; +} + +/** + * Product profile. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ProductTagResourceContractProperties extends ProductEntityBaseParameters { + /** + * Identifier of the product in the form of /products/{productId} + */ + id?: string; + + /** + * Product name. + */ + @maxLength(300) + @minLength(1) + name: string; +} + +/** + * Wiki contract details + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model WikiContractProperties { + /** + * Collection wiki documents included into this wiki. + */ + @OpenAPI.extension("x-ms-identifiers", #["documentationId"]) + documents?: WikiDocumentationContract[]; +} + +/** + * Wiki documentation details. + */ +model WikiDocumentationContract { + /** + * Documentation Identifier + */ + documentationId?: string; +} + +/** + * Wiki update contract details. + */ +model WikiUpdateContract { + /** + * Wiki details. + */ + properties?: WikiContractProperties; +} + +/** + * Paged Wiki list representation. + */ +model WikiCollection { + /** + * Page values. + */ + @pageItems + @OpenAPI.extension("x-ms-identifiers", #["name"]) + @visibility(Lifecycle.Read) + value?: WikiContract[]; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * API Export result. + */ +model ApiExportResult { + /** + * ResourceId of the API which was exported. + */ + id?: string; + + /** + * Format in which the API Details are exported to the Storage Blob with Sas Key valid for 5 minutes. + */ + format?: ExportResultFormat; + + /** + * The object defining the schema of the exported API Detail + */ + value?: ApiExportResultValue; +} + +/** + * The object defining the schema of the exported API Detail + */ +model ApiExportResultValue { + /** + * Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes. + */ + link?: string; +} + +/** + * Paged API Version Set list representation. + */ +model ApiVersionSetCollection { + /** + * Page values. + */ + @pageItems + value?: ApiVersionSetContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Properties of an API Version Set. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiVersionSetContractProperties extends ApiVersionSetEntityBase { + /** + * Name of API Version Set + */ + @maxLength(100) + @minLength(1) + displayName: string; + + /** + * An value that determines where the API Version identifier will be located in a HTTP request. + */ + versioningScheme: VersioningScheme; +} + +/** + * API Version set base parameters + */ +model ApiVersionSetEntityBase { + /** + * Description of API Version Set. + */ + description?: string; + + /** + * Name of query parameter that indicates the API Version if versioningScheme is set to `query`. + */ + @maxLength(100) + @minLength(1) + versionQueryName?: string; + + /** + * Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. + */ + @maxLength(100) + @minLength(1) + versionHeaderName?: string; +} + +/** + * Parameters to update or create an API Version Set Contract. + */ +model ApiVersionSetUpdateParameters { + /** + * Parameters to update or create an API Version Set Contract. + */ + properties?: ApiVersionSetUpdateParametersProperties; +} + +/** + * Properties used to create or update an API Version Set. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiVersionSetUpdateParametersProperties extends ApiVersionSetEntityBase { + /** + * Name of API Version Set + */ + @maxLength(100) + @minLength(1) + displayName?: string; + + /** + * An value that determines where the API Version identifier will be located in a HTTP request. + */ + versioningScheme?: VersioningScheme; +} + +/** + * Paged Authorization Provider list representation. + */ +model AuthorizationProviderCollection { + /** + * Page values. + */ + @pageItems + value?: AuthorizationProviderContract[]; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Authorization Provider details. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AuthorizationProviderContractProperties { + /** + * Authorization Provider name. Must be 1 to 300 characters long. + */ + @maxLength(300) + @minLength(1) + displayName?: string; + + /** + * Identity provider name. Must be 1 to 300 characters long. + */ + identityProvider?: string; + + /** + * OAuth2 settings + */ + oauth2?: AuthorizationProviderOAuth2Settings; +} + +/** + * OAuth2 settings details + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AuthorizationProviderOAuth2Settings { + /** + * Redirect URL to be set in the OAuth application. + */ + redirectUrl?: string; + + /** + * OAuth2 settings + */ + grantTypes?: AuthorizationProviderOAuth2GrantTypes; +} + +/** + * Authorization Provider oauth2 grant types settings + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AuthorizationProviderOAuth2GrantTypes { + /** + * OAuth2 authorization code grant parameters + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + authorizationCode?: Record; + + /** + * OAuth2 client credential grant parameters + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + clientCredentials?: Record; +} + +/** + * Paged Authorization list representation. + */ +model AuthorizationCollection { + /** + * Page values. + */ + @pageItems + value?: AuthorizationContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Authorization details. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AuthorizationContractProperties { + /** + * Authorization type options + */ + authorizationType?: AuthorizationType; + + /** + * OAuth2 grant type options + */ + oauth2grantType?: OAuth2GrantType; + + /** + * Authorization parameters + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + parameters?: Record; + + /** + * Authorization error details. + */ + error?: AuthorizationError; + + /** + * Status of the Authorization + */ + status?: string; +} + +/** + * Authorization error details. + */ +model AuthorizationError { + /** + * Error code + */ + code?: string; + + /** + * Error message + */ + message?: string; +} + +/** + * Authorization login request contract. + */ +model AuthorizationLoginRequestContract { + /** + * The redirect URL after login has completed. + */ + postLoginRedirectUrl?: string; +} + +/** + * Authorization login response contract. + */ +model AuthorizationLoginResponseContract { + /** + * The login link + */ + loginLink?: string; +} + +/** + * Authorization confirm consent code request contract. + */ +model AuthorizationConfirmConsentCodeRequestContract { + /** + * The consent code from the authorization server after authorizing and consenting. + */ + consentCode?: string; +} + +/** + * Paged Authorization Access Policy list representation. + */ +model AuthorizationAccessPolicyCollection { + /** + * Page values. + */ + @pageItems + value?: AuthorizationAccessPolicyContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Paged Authorization Access Policy list representation. + */ + @nextLink + nextLink?: string; +} +/** + * Authorization Access Policy details. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AuthorizationAccessPolicyContractProperties { + /** + * The allowed Azure Active Directory Application IDs + */ + appIds?: string[]; + + /** + * The Tenant Id + */ + tenantId?: string; + + /** + * The Object Id + */ + objectId?: string; +} + +/** + * Paged OAuth2 Authorization Servers list representation. + */ +model AuthorizationServerCollection { + /** + * Page values. + */ + @pageItems + value?: AuthorizationServerContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * External OAuth authorization server settings Properties. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AuthorizationServerContractProperties + extends AuthorizationServerContractBaseProperties { + /** + * User-friendly authorization server name. + */ + @maxLength(50) + @minLength(1) + displayName: string; + + /** + * If true, the authorization server may be used in the developer portal test console. True by default if no value is provided. + */ + useInTestConsole?: boolean; + + /** + * If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided. + */ + useInApiDocumentation?: boolean; + + /** + * Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced. + */ + clientRegistrationEndpoint: string; + + /** + * OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. + */ + authorizationEndpoint: string; + + /** + * Form of an authorization grant, which the client uses to request the access token. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @OpenAPI.externalDocs("http://tools.ietf.org/html/rfc6749#section-4") + grantTypes: GrantType[]; + + /** + * Client or app id registered with this authorization server. + */ + clientId: string; + + /** + * Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. + */ + @secret + clientSecret?: string; +} + +/** + * External OAuth authorization server Update settings contract. + */ +model AuthorizationServerContractBaseProperties { + /** + * Description of the authorization server. Can contain HTML formatting tags. + */ + description?: string; + + /** + * HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. + */ + authorizationMethods?: AuthorizationMethod[]; + + /** + * Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format. + */ + clientAuthenticationMethod?: ClientAuthenticationMethod[]; + + /** + * Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}. + */ + @OpenAPI.extension("x-ms-identifiers", #["name"]) + tokenBodyParameters?: TokenBodyParameterContract[]; + + /** + * OAuth token endpoint. Contains absolute URI to entity being referenced. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @OpenAPI.externalDocs("http://tools.ietf.org/html/rfc6749#section-3.1") + tokenEndpoint?: string; + + /** + * If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @OpenAPI.externalDocs("http://tools.ietf.org/html/rfc6749#section-3.1") + supportState?: boolean; + + /** + * Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @OpenAPI.externalDocs("http://tools.ietf.org/html/rfc6749#section-3.3") + defaultScope?: string; + + /** + * Specifies the mechanism by which access token is passed to the API. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @OpenAPI.externalDocs("http://tools.ietf.org/html/rfc6749#section-4") + bearerTokenSendingMethods?: BearerTokenSendingMethod[]; + + /** + * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. + */ + resourceOwnerUsername?: string; + + /** + * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. + */ + resourceOwnerPassword?: string; +} + +/** + * OAuth acquire token request body parameter (www-url-form-encoded). + */ +model TokenBodyParameterContract { + /** + * body parameter name. + */ + name: string; + + /** + * body parameter value. + */ + value: string; +} + +/** + * External OAuth authorization server settings. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AuthorizationServerUpdateContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Properties of the External OAuth authorization server update Contract. + */ + properties?: AuthorizationServerUpdateContractProperties; +} + +/** + * External OAuth authorization server Update settings contract. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AuthorizationServerUpdateContractProperties + extends AuthorizationServerContractBaseProperties { + /** + * User-friendly authorization server name. + */ + @maxLength(50) + @minLength(1) + displayName?: string; + + /** + * If true, the authorization server may be used in the developer portal test console. True by default if no value is provided. + */ + useInTestConsole?: boolean; + + /** + * If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided. + */ + useInApiDocumentation?: boolean; + + /** + * Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced. + */ + clientRegistrationEndpoint?: string; + + /** + * OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. + */ + authorizationEndpoint?: string; + + /** + * Form of an authorization grant, which the client uses to request the access token. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @OpenAPI.externalDocs("http://tools.ietf.org/html/rfc6749#section-4") + grantTypes?: GrantType[]; + + /** + * Client or app id registered with this authorization server. + */ + clientId?: string; + + /** + * Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. + */ + @secret + clientSecret?: string; +} + +/** + * OAuth Server Secrets Contract. + */ +model AuthorizationServerSecretsContract { + /** + * oAuth Authorization Server Secrets. + */ + @secret + clientSecret?: string; + + /** + * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. + */ + resourceOwnerUsername?: string; + + /** + * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. + */ + resourceOwnerPassword?: string; +} + +/** + * Paged Backend list representation. + */ +model BackendCollection { + /** + * Backend values. + */ + @pageItems + value?: BackendContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Parameters supplied to the Create Backend operation. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BackendContractProperties extends BackendBaseParameters { + /** + * Runtime Url of the Backend. Required when backend type is 'Single'. + */ + @maxLength(2000) + @minLength(1) + url?: string; + + /** + * Backend communication protocol. Required when backend type is 'Single'. + */ + protocol?: BackendProtocol; +} + +/** + * Backend entity base Parameter set. + */ +model BackendBaseParameters { + /** + * Backend Title. + */ + @maxLength(300) + @minLength(1) + title?: string; + + /** + * Backend Description. + */ + @maxLength(2000) + @minLength(1) + description?: string; + + /** + * Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps. + */ + @maxLength(2000) + @minLength(1) + resourceId?: string; + + /** + * Backend Properties contract + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + properties?: BackendProperties; + + /** + * Backend Credentials Contract Properties + */ + credentials?: BackendCredentialsContract; + + /** + * Backend gateway Contract Properties + */ + proxy?: BackendProxyContract; + + /** + * Backend TLS Properties + */ + tls?: BackendTlsProperties; + + /** + * Backend Circuit Breaker Configuration + */ + circuitBreaker?: BackendCircuitBreaker; + + /** + * Backend Pool Properties + */ + pool?: BackendBaseParametersPool; + + /** + * Type of the backend. A backend can be either Single or Pool. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + type?: BackendType; +} + +/** + * Properties specific to the Backend Type. + */ +model BackendProperties { + /** + * Backend Service Fabric Cluster Properties + */ + serviceFabricCluster?: BackendServiceFabricClusterProperties; +} + +/** + * Properties of the Service Fabric Type Backend. + */ +model BackendServiceFabricClusterProperties { + /** + * The client certificate id for the management endpoint. + */ + clientCertificateId?: string; + + /** + * The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided + */ + clientCertificatethumbprint?: string; + + /** + * Maximum number of retries while attempting resolve the partition. + */ + maxPartitionResolutionRetries?: int32; + + /** + * The cluster management endpoint. + */ + managementEndpoints: string[]; + + /** + * Thumbprints of certificates cluster management service uses for tls communication + */ + serverCertificateThumbprints?: string[]; + + /** + * Server X509 Certificate Names Collection + */ + @OpenAPI.extension("x-ms-identifiers", #["name"]) + serverX509Names?: X509CertificateName[]; +} + +/** + * Properties of server X509Names. + */ +#suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@OpenAPI.externalDocs("https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-windows-cluster-x509-security") +model X509CertificateName { + /** + * Common Name of the Certificate. + */ + name?: string; + + /** + * Thumbprint for the Issuer of the Certificate. + */ + issuerCertificateThumbprint?: string; +} + +/** + * Details of the Credentials used to connect to Backend. + */ +model BackendCredentialsContract { + /** + * List of Client Certificate Ids. + */ + @maxItems(32) + certificateIds?: string[]; + + /** + * List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided. + */ + @maxItems(32) + certificate?: string[]; + + /** + * Query Parameter description. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + query?: Record; + + /** + * Header Parameter description. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + header?: Record; + + /** + * Authorization header authentication + */ + authorization?: BackendAuthorizationHeaderCredentials; +} + +/** + * Authorization header information. + */ +model BackendAuthorizationHeaderCredentials { + /** + * Authentication Scheme name. + */ + @maxLength(100) + @minLength(1) + scheme: string; + + /** + * Authentication Parameter value. + */ + @maxLength(300) + @minLength(1) + parameter: string; +} + +/** + * Details of the Backend WebProxy Server to use in the Request to Backend. + */ +#suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@OpenAPI.externalDocs( + "https://msdn.microsoft.com/en-us/library/system.net.webproxy(v=vs.110).aspx", + "Backend entity uses these details to connect to a WebProxy." +) +model BackendProxyContract { + /** + * WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. + */ + @maxLength(2000) + @minLength(1) + url: string; + + /** + * Username to connect to the WebProxy server + */ + username?: string; + + /** + * Password to connect to the WebProxy Server + */ + password?: string; +} + +/** + * Properties controlling TLS Certificate Validation. + */ +model BackendTlsProperties { + /** + * Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. + */ + validateCertificateChain?: boolean = true; + + /** + * Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. + */ + validateCertificateName?: boolean = true; +} + +/** + * The configuration of the backend circuit breaker + */ +model BackendCircuitBreaker { + /** + * The rules for tripping the backend. + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + rules?: CircuitBreakerRule[]; +} + +/** + * Rule configuration to trip the backend. + */ +model CircuitBreakerRule { + /** + * The rule name. + */ + name?: string; + + /** + * The conditions for tripping the circuit breaker. + */ + failureCondition?: CircuitBreakerFailureCondition; + + /** + * The duration for which the circuit will be tripped. + */ + tripDuration?: duration; + + /** + * flag to accept Retry-After header from the backend. + */ + acceptRetryAfter?: boolean; + + /** + * The response of the backend when the circuit breaker gets open. + */ + failureResponse?: BackendFailureResponse; +} + +/** + * The trip conditions of the circuit breaker + */ +model CircuitBreakerFailureCondition { + /** + * The threshold for opening the circuit. + */ + count?: int64; + + /** + * The threshold for opening the circuit. + */ + percentage?: int64; + + /** + * The interval during which the failures are counted. + */ + interval?: duration; + + /** + * The status code ranges which are considered as failure. + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + @maxItems(10) + statusCodeRanges?: FailureStatusCodeRange[]; + + /** + * The error reasons which are considered as failure. + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + @maxItems(10) + errorReasons?: string[]; +} + +/** + * The failure http status code range + */ +model FailureStatusCodeRange { + /** + * The minimum http status code. + */ + @maxValue(599) + @minValue(200) + min?: int32; + + /** + * The maximum http status code. + */ + @maxValue(599) + @minValue(200) + max?: int32; +} + +/** + * The response to be returned when a backend fails to respond + */ +model BackendFailureResponse { + /** + * The status code of the response. + */ + @maxValue(599) + @minValue(100) + statusCode?: int32; +} + +/** + * Backend Pool Properties + */ +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BackendBaseParametersPool extends BackendPool {} + +/** + * Backend pool information + */ +model BackendPool { + /** + * The list of backend entities belonging to a pool. + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + @minItems(1) + services?: BackendPoolItem[]; + + /** + * The response to be returned when all the backends in the pool are inactive. + */ + failureResponse?: BackendFailureResponse; + + /** + * The session stickiness properties of the backend pool. + */ + sessionAffinity?: BackendSessionAffinity; +} + +/** + * Backend pool service information + */ +model BackendPoolItem { + /** + * The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity. + */ + id: Azure.Core.armResourceIdentifier; + + /** + * The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified. + */ + @maxValue(100) + @minValue(0) + weight?: int32; + + /** + * The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified. + */ + @maxValue(100) + @minValue(0) + priority?: int32; +} + +/** + * The session stickiness properties of the backend pool. + */ +model BackendSessionAffinity { + /** + * The id that identifies the requests belonging to the same session. + */ + sessionId?: BackendSessionId; +} + +/** + * The properties of the id that identifies the requests belonging to the same session. + */ +model BackendSessionId { + /** + * Source from where the session id is extracted. + */ + source?: BackendSessionIdSource; + + /** + * Name of the variable that refers to the session id. + */ + name?: string; +} + +/** + * Backend update parameters. + */ +model BackendUpdateParameters { + /** + * Backend entity update contract properties. + */ + properties?: BackendUpdateParameterProperties; +} + +/** + * Parameters supplied to the Update Backend operation. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BackendUpdateParameterProperties extends BackendBaseParameters { + /** + * Runtime Url of the Backend. Required when backend type is 'Single'. + */ + @maxLength(2000) + @minLength(1) + url?: string; + + /** + * Backend communication protocol. Required when backend type is 'Single'. + */ + protocol?: BackendProtocol; +} + +/** + * Reconnect request parameters. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model BackendReconnectContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Reconnect request properties. + */ + properties?: BackendReconnectProperties; +} + +/** + * Properties to control reconnect requests. + */ +model BackendReconnectProperties { + /** + * Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconnect is PT2M. + */ + after?: duration; +} + +/** + * Paged Caches list representation. + */ +model CacheCollection { + /** + * Page values. + */ + @pageItems + value?: CacheContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Properties of the Cache contract. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model CacheContractProperties { + /** + * Cache description + */ + @maxLength(2000) + description?: string; + + /** + * Runtime connection string to cache + */ + @maxLength(300) + connectionString: string; + + /** + * Location identifier to use cache from (should be either 'default' or valid Azure region identifier) + */ + @maxLength(256) + useFromLocation: string; + + /** + * Original uri of entity in external system cache points to + */ + @maxLength(2000) + resourceId?: string; +} + +/** + * Cache update details. + */ +model CacheUpdateParameters { + /** + * Cache update properties details. + */ + properties?: CacheUpdateProperties; +} + +/** + * Parameters supplied to the Update Cache operation. + */ +model CacheUpdateProperties { + /** + * Cache description + */ + @maxLength(2000) + description?: string; + + /** + * Runtime connection string to cache + */ + @maxLength(300) + connectionString?: string; + + /** + * Location identifier to use cache from (should be either 'default' or valid Azure region identifier) + */ + @maxLength(256) + useFromLocation?: string; + + /** + * Original uri of entity in external system cache points to + */ + @maxLength(2000) + resourceId?: string; +} + +/** + * Paged Certificates list representation. + */ +model CertificateCollection { + /** + * Page values. + */ + @pageItems + value?: CertificateContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Properties of the Certificate contract. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model CertificateContractProperties { + /** + * Subject attribute of the certificate. + */ + subject: string; + + /** + * Thumbprint of the certificate. + */ + thumbprint: string; + + /** + * Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expirationDate: utcDateTime; + + /** + * KeyVault location details of the certificate. + */ + keyVault?: KeyVaultContractProperties; +} + +/** + * KeyVault contract details. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model KeyVaultContractProperties extends KeyVaultContractCreateProperties { + /** + * Last time sync and refresh status of secret from key vault. + */ + lastStatus?: KeyVaultLastAccessStatusContractProperties; +} + +/** + * Issue contract Update Properties. + */ +model KeyVaultLastAccessStatusContractProperties { + /** + * Last status code for sync and refresh of secret from key vault. + */ + code?: string; + + /** + * Details of the error else empty. + */ + message?: string; + + /** + * Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + timeStampUtc?: utcDateTime; +} + +/** + * Create keyVault contract details. + */ +model KeyVaultContractCreateProperties { + /** + * Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi + */ + secretIdentifier?: string; + + /** + * Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. + */ + identityClientId?: string; +} + +/** + * Certificate create or update details. + */ +model CertificateCreateOrUpdateParameters { + /** + * Certificate create or update properties details. + */ + properties?: CertificateCreateOrUpdateProperties; +} + +/** + * Parameters supplied to the CreateOrUpdate certificate operation. + */ +model CertificateCreateOrUpdateProperties { + /** + * Base 64 encoded certificate using the application/x-pkcs12 representation. + */ + data?: string; + + /** + * Password for the Certificate + */ + password?: string; + + /** + * KeyVault location details of the certificate. + */ + keyVault?: KeyVaultContractCreateProperties; +} + +/** + * A request to perform the connectivity check operation on a API Management service. + */ +model ConnectivityCheckRequest { + /** + * Definitions about the connectivity check origin. + */ + source: ConnectivityCheckRequestSource; + + /** + * The connectivity check operation destination. + */ + destination: ConnectivityCheckRequestDestination; + + /** + * The IP version to be used. Only IPv4 is supported for now. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + preferredIPVersion?: PreferredIPVersion; + + /** + * The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value. + */ + protocol?: ConnectivityCheckProtocol; + + /** + * Protocol-specific configuration. + */ + protocolConfiguration?: ConnectivityCheckRequestProtocolConfiguration; +} + +/** + * Definitions about the connectivity check origin. + */ +model ConnectivityCheckRequestSource { + /** + * The API Management service region from where to start the connectivity check operation. + */ + region: string; + + /** + * The particular VMSS instance from which to fire the request. + */ + instance?: int64; +} + +/** + * The connectivity check operation destination. + */ +model ConnectivityCheckRequestDestination { + /** + * Destination address. Can either be an IP address or a FQDN. + */ + address: string; + + /** + * Destination port. + */ + port: int64; +} + +/** + * Protocol-specific configuration. + */ +model ConnectivityCheckRequestProtocolConfiguration { + /** + * Configuration for HTTP or HTTPS requests. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + HTTPConfiguration?: ConnectivityCheckRequestProtocolConfigurationHttpConfiguration; +} + +/** + * Configuration for HTTP or HTTPS requests. + */ +model ConnectivityCheckRequestProtocolConfigurationHttpConfiguration { + /** + * The HTTP method to be used. + */ + method?: Method; + + /** + * List of HTTP status codes considered valid for the request response. + */ + validStatusCodes?: int64[]; + + /** + * List of headers to be included in the request. + */ + @OpenAPI.extension("x-ms-identifiers", #["name"]) + headers?: HttpHeader[]; +} + +/** + * HTTP header and it's value. + */ +model HttpHeader { + /** + * Header name. + */ + name: string; + + /** + * Header value. + */ + value: string; +} + +/** + * Information on the connectivity status. + */ +model ConnectivityCheckResponse { + /** + * List of hops between the source and the destination. + */ + @visibility(Lifecycle.Read) + hops?: ConnectivityHop[]; + + /** + * The connection status. + */ + @visibility(Lifecycle.Read) + connectionStatus?: ConnectionStatus; + + /** + * Average latency in milliseconds. + */ + @visibility(Lifecycle.Read) + avgLatencyInMs?: int64; + + /** + * Minimum latency in milliseconds. + */ + @visibility(Lifecycle.Read) + minLatencyInMs?: int64; + + /** + * Maximum latency in milliseconds. + */ + @visibility(Lifecycle.Read) + maxLatencyInMs?: int64; + + /** + * Total number of probes sent. + */ + @visibility(Lifecycle.Read) + probesSent?: int64; + + /** + * Number of failed probes. + */ + @visibility(Lifecycle.Read) + probesFailed?: int64; +} + +/** + * Information about a hop between the source and the destination. + */ +model ConnectivityHop { + /** + * The type of the hop. + */ + @visibility(Lifecycle.Read) + type?: string; + + /** + * The ID of the hop. + */ + @visibility(Lifecycle.Read) + id?: string; + + /** + * The IP address of the hop. + */ + @visibility(Lifecycle.Read) + address?: string; + + /** + * The ID of the resource corresponding to this hop. + */ + @visibility(Lifecycle.Read) + resourceId?: string; + + /** + * List of next hop identifiers. + */ + @visibility(Lifecycle.Read) + nextHopIds?: string[]; + + /** + * List of issues. + */ + @visibility(Lifecycle.Read) + @OpenAPI.extension("x-ms-identifiers", #[]) + issues?: ConnectivityIssue[]; +} + +/** + * Information about an issue encountered in the process of checking for connectivity. + */ +model ConnectivityIssue { + /** + * The origin of the issue. + */ + @visibility(Lifecycle.Read) + origin?: Origin; + + /** + * The severity of the issue. + */ + @visibility(Lifecycle.Read) + severity?: Severity; + + /** + * The type of issue. + */ + @visibility(Lifecycle.Read) + type?: IssueType; + + /** + * Provides additional context on the issue. + */ + @visibility(Lifecycle.Read) + @OpenAPI.extension("x-ms-identifiers", #[]) + context?: Record[]; +} + +/** + * Paged list of content types. + */ +model ContentTypeCollection { + /** + * Collection of content items. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: ContentTypeContract[]; + + /** + * Next page link, if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ContentTypeContractProperties { + /** + * Content type identifier + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + id?: string; + + /** + * Content type name. Must be 1 to 250 characters long. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + name?: string; + + /** + * Content type description. + */ + description?: string; + + /** + * Content type schema. + */ + #suppress "@azure-tools/typespec-azure-core/no-unknown" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + schema?: unknown; + + /** + * Content type version. + */ + version?: string; +} + +/** + * Paged list of content items. + */ +model ContentItemCollection { + /** + * Collection of content items. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: ContentItemContract[]; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * Paged deleted API Management Services List Representation. + */ +model DeletedServicesCollection { + /** + * Page values. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: DeletedServiceContract[]; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model DeletedServiceContractProperties { + /** + * Fully-qualified API Management Service Resource ID + */ + serviceId?: string; + + /** + * UTC Date and Time when the service will be automatically purged. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + scheduledPurgeDate?: utcDateTime; + + /** + * UTC Timestamp when the service was soft-deleted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + deletionDate?: utcDateTime; +} + +/** + * REST API operation + */ +model Operation { + /** + * Operation name: {provider}/{resource}/{operation} + */ + name?: string; + + /** + * The object that describes the operation. + */ + display?: OperationDisplay; + + /** + * The operation origin. + */ + origin?: string; + + /** + * The operation properties. + */ + #suppress "@azure-tools/typespec-azure-core/no-unknown" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + properties?: unknown; +} + +/** + * The object that describes the operation. + */ +model OperationDisplay { + /** + * Friendly name of the resource provider + */ + provider?: string; + + /** + * Operation type: read, write, delete, listKeys/action, etc. + */ + operation?: string; + + /** + * Resource type on which the operation is performed. + */ + resource?: string; + + /** + * Friendly name of the operation + */ + description?: string; +} + +/** + * The API Management service SKUs operation response. + */ +model ResourceSkuResults { + /** + * The list of skus available for the service. + */ + @pageItems + @OpenAPI.extension("x-ms-identifiers", #["resourceType", "sku/name"]) + value: ResourceSkuResult[]; + + /** + * The uri to fetch the next page of API Management service Skus. + */ + @nextLink + nextLink?: string; +} + +/** + * Describes an available API Management service SKU. + */ +model ResourceSkuResult { + /** + * The type of resource the SKU applies to. + */ + @visibility(Lifecycle.Read) + resourceType?: string; + + /** + * Specifies API Management SKU. + */ + @visibility(Lifecycle.Read) + sku?: ResourceSku; + + /** + * Specifies the number of API Management units. + */ + @visibility(Lifecycle.Read) + capacity?: ResourceSkuCapacity; +} + +/** + * Describes an available API Management SKU. + */ +model ResourceSku { + /** + * Name of the Sku. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @OpenAPI.externalDocs("https://azure.microsoft.com/en-us/pricing/details/api-management/") + name?: SkuType; +} + +/** + * Describes scaling information of a SKU. + */ +model ResourceSkuCapacity { + /** + * The minimum capacity. + */ + @visibility(Lifecycle.Read) + minimum?: int32; + + /** + * The maximum capacity that can be set. + */ + @visibility(Lifecycle.Read) + maximum?: int32; + + /** + * The default capacity. + */ + @visibility(Lifecycle.Read) + default?: int32; + + /** + * The scale type applicable to the sku. + */ + @visibility(Lifecycle.Read) + scaleType?: ResourceSkuCapacityScaleType; +} + +/** + * Parameters supplied to the Backup/Restore of an API Management service operation. + */ +model ApiManagementServiceBackupRestoreParameters { + /** + * The name of the Azure storage account (used to place/retrieve the backup). + */ + storageAccount: string; + + /** + * The name of the blob container (used to place/retrieve the backup). + */ + containerName: string; + + /** + * The name of the backup file to create/retrieve. + */ + backupName: string; + + /** + * The type of access to be used for the storage account. + */ + accessType?: AccessType = AccessType.AccessKey; + + /** + * Storage account access key. Required only if `accessType` is set to `AccessKey`. + */ + accessKey?: string; + + /** + * The Client ID of user assigned managed identity. Required only if `accessType` is set to `UserAssignedManagedIdentity`. + */ + clientId?: string; +} + +/** + * Properties of an API Management service resource description. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiManagementServiceProperties + extends ApiManagementServiceBaseProperties { + /** + * Publisher email. + */ + @maxLength(100) + publisherEmail: string; + + /** + * Publisher name. + */ + @maxLength(100) + publisherName: string; +} + +/** + * Base Properties of an API Management service resource description. + */ +model ApiManagementServiceBaseProperties { + /** + * Email address from which the notification will be sent. + */ + @maxLength(100) + notificationSenderEmail?: string; + + /** + * The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + provisioningState?: string; + + /** + * The provisioning state of the API Management service, which is targeted by the long running operation started on the service. + */ + @visibility(Lifecycle.Read) + targetProvisioningState?: string; + + /** + * Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + createdAtUtc?: utcDateTime; + + /** + * Gateway URL of the API Management service. + */ + @visibility(Lifecycle.Read) + gatewayUrl?: string; + + /** + * Gateway URL of the API Management service in the Default Region. + */ + @visibility(Lifecycle.Read) + gatewayRegionalUrl?: string; + + /** + * Publisher portal endpoint Url of the API Management service. + */ + @visibility(Lifecycle.Read) + portalUrl?: string; + + /** + * Management API endpoint URL of the API Management service. + */ + @visibility(Lifecycle.Read) + managementApiUrl?: string; + + /** + * SCM endpoint URL of the API Management service. + */ + @visibility(Lifecycle.Read) + scmUrl?: string; + + /** + * DEveloper Portal endpoint URL of the API Management service. + */ + @visibility(Lifecycle.Read) + developerPortalUrl?: string; + + /** + * Custom hostname configuration of the API Management service. + */ + @OpenAPI.extension("x-ms-identifiers", #["hostName", "type"]) + hostnameConfigurations?: HostnameConfiguration[]; + + /** + * Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + publicIPAddresses?: string[]; + + /** + * Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + privateIPAddresses?: string[]; + + /** + * Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network. + */ + publicIpAddressId?: string; + + /** + * Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' + */ + publicNetworkAccess?: PublicNetworkAccess; + + /** + * Configuration API configuration of the API Management service. + */ + configurationApi?: ConfigurationApi; + + /** + * Virtual network configuration of the API Management service. + */ + virtualNetworkConfiguration?: VirtualNetworkConfiguration; + + /** + * Additional datacenter locations of the API Management service. + */ + @OpenAPI.extension("x-ms-identifiers", #["location", "sku"]) + additionalLocations?: AdditionalLocation[]; + + /** + * Custom properties of the API Management service.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` can be used to disable just TLS 1.1 for communications with backends.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` can be used to disable TLS 1.0 for communications with backends.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` can be used to enable HTTP2 protocol on an API Management service.
Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is `True` if the service was created on or before April 1, 2018 and `False` otherwise. Http2 setting's default value is `False`.

You can disable any of the following ciphers by using settings `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. The default value is `true` for them.
Note: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + customProperties?: Record; + + /** + * List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. + */ + @OpenAPI.extension("x-ms-identifiers", #["certificate/thumbprint"]) + certificates?: CertificateConfiguration[]; + + /** + * Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway. + */ + enableClientCertificate?: boolean = false; + + /** + * Property can be used to enable NAT Gateway for this API Management service. + */ + natGatewayState?: NatGatewayState = NatGatewayState.Disabled; + + /** + * Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + outboundPublicIPAddresses?: string[]; + + /** + * Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. + */ + disableGateway?: boolean = false; + + /** + * The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. + */ + virtualNetworkType?: VirtualNetworkType = VirtualNetworkType.None; + + /** + * Control Plane Apis version constraint for the API Management service. + */ + apiVersionConstraint?: ApiVersionConstraint; + + /** + * Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. + */ + restore?: boolean = false; + + /** + * List of Private Endpoint Connections of this service. + */ + privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]; + + /** + * Compute Platform Version running the service in this location. + */ + @visibility(Lifecycle.Read) + platformVersion?: PlatformVersion; + + /** + * Status of legacy portal in the API Management service. + */ + legacyPortalStatus?: LegacyPortalStatus = LegacyPortalStatus.Enabled; + + /** + * Status of developer portal in this API Management service. + */ + developerPortalStatus?: DeveloperPortalStatus = DeveloperPortalStatus.Enabled; + + /** + * Release Channel of this API Management service. + */ + releaseChannel?: ReleaseChannel; +} + +/** + * Custom hostname configuration. + */ +model HostnameConfiguration { + /** + * Hostname type. + */ + type: HostnameType; + + /** + * Hostname to configure on the Api Management service. + */ + hostName: string; + + /** + * Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type *application/x-pkcs12* + */ + keyVaultId?: string; + + /** + * System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. + */ + identityClientId?: string; + + /** + * Base64 Encoded certificate. + */ + encodedCertificate?: string; + + /** + * Certificate Password. + */ + certificatePassword?: string; + + /** + * Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type. + */ + defaultSslBinding?: boolean = false; + + /** + * Specify true to always negotiate client certificate on the hostname. Default Value is false. + */ + negotiateClientCertificate?: boolean = false; + + /** + * Certificate information. + */ + certificate?: CertificateInformation; + + /** + * Certificate Source. + */ + certificateSource?: CertificateSource; + + /** + * Certificate Status. + */ + certificateStatus?: CertificateStatus; +} + +/** + * SSL certificate information. + */ +model CertificateInformation { + /** + * Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expiry: utcDateTime; + + /** + * Thumbprint of the certificate. + */ + thumbprint: string; + + /** + * Subject of the certificate. + */ + subject: string; +} + +/** + * Information regarding the Configuration API of the API Management service. + */ +model ConfigurationApi { + /** + * Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled' + */ + legacyApi?: LegacyApiState = LegacyApiState.Enabled; +} + +/** + * Configuration of a virtual network to which API Management service is deployed. + */ +model VirtualNetworkConfiguration { + /** + * The virtual network ID. This is typically a GUID. Expect a null GUID by default. + */ + @visibility(Lifecycle.Read) + vnetid?: string; + + /** + * The name of the subnet. + */ + @visibility(Lifecycle.Read) + subnetname?: string; + + /** + * The full resource ID of a subnet in a virtual network to deploy the API Management service in. + */ + @pattern("^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$") + subnetResourceId?: string; +} + +/** + * Description of an additional API Management resource location. + */ +model AdditionalLocation { + /** + * The location name of the additional region among Azure Data center regions. + */ + location: string; + + /** + * SKU properties of the API Management service. + */ + sku: ApiManagementServiceSkuProperties; + + /** + * A list of availability zones denoting where the resource needs to come from. + */ + zones?: string[]; + + /** + * Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + publicIPAddresses?: string[]; + + /** + * Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + privateIPAddresses?: string[]; + + /** + * Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network. + */ + publicIpAddressId?: string; + + /** + * Virtual network configuration for the location. + */ + virtualNetworkConfiguration?: VirtualNetworkConfiguration; + + /** + * Gateway URL of the API Management service in the Region. + */ + @visibility(Lifecycle.Read) + gatewayRegionalUrl?: string; + + /** + * Property can be used to enable NAT Gateway for this API Management service. + */ + natGatewayState?: NatGatewayState = NatGatewayState.Disabled; + + /** + * Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + outboundPublicIPAddresses?: string[]; + + /** + * Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location. + */ + disableGateway?: boolean = false; + + /** + * Compute Platform Version running the service. + */ + @visibility(Lifecycle.Read) + platformVersion?: PlatformVersion; +} + +/** + * API Management service resource SKU properties. + */ +model ApiManagementServiceSkuProperties { + /** + * Name of the Sku. + */ + name: SkuType; + + /** + * Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. + */ + capacity: int32; +} + +/** + * Certificate configuration which consist of non-trusted intermediates and root certificates. + */ +model CertificateConfiguration { + /** + * Base64 Encoded certificate. + */ + encodedCertificate?: string; + + /** + * Certificate Password. + */ + certificatePassword?: string; + + /** + * The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. + */ + storeName: CertificateConfigurationStoreName; + + /** + * Certificate information. + */ + certificate?: CertificateInformation; +} + +/** + * Control Plane Apis version constraint for the API Management service. + */ +model ApiVersionConstraint { + /** + * Limit control plane API calls to API Management service with version equal to or newer than this value. + */ + minApiVersion?: string; +} + +/** + * Remote Private Endpoint Connection resource. + */ +model RemotePrivateEndpointConnectionWrapper { + /** + * Private Endpoint connection resource id + */ + id?: string; + + /** + * Private Endpoint Connection Name + */ + name?: string; + + /** + * Private Endpoint Connection Resource Type + */ + type?: string; + + /** + * Resource properties. + */ + properties?: PrivateEndpointConnectionWrapperProperties; +} + +/** + * Properties of the PrivateEndpointConnectProperties. + */ +model PrivateEndpointConnectionWrapperProperties { + /** + * The resource of private end point. + */ + privateEndpoint?: ArmIdWrapper; + + /** + * A collection of information about the state of the connection between service consumer and provider. + */ + privateLinkServiceConnectionState: Azure.ResourceManager.CommonTypes.PrivateLinkServiceConnectionState; + + /** + * The provisioning state of the private endpoint connection resource. + */ + @visibility(Lifecycle.Read) + provisioningState?: string; + + /** + * All the Group ids. + */ + @visibility(Lifecycle.Read) + groupIds?: string[]; +} + +/** + * A wrapper for an ARM resource id + */ +model ArmIdWrapper { + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + id?: string; +} + +/** + * Identity properties of the Api Management service resource. + */ +model ApiManagementServiceIdentity { + /** + * The type of identity used for the resource. 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 service. + */ + type: ApimIdentityType; + + /** + * The principal id of the identity. + */ + #suppress "@azure-tools/typespec-azure-core/no-format" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + @format("uuid") + principalId?: string; + + /** + * The client tenant id of the identity. + */ + #suppress "@azure-tools/typespec-azure-core/no-format" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + @format("uuid") + tenantId?: string; + + /** + * The list of user identities associated with the resource. The user identity + * dictionary key references will be ARM resource ids in the form: + * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ + * providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + userAssignedIdentities?: Record; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model UserIdentityProperties { + /** + * The principal id of user assigned identity. + */ + principalId?: string; + + /** + * The client id of user assigned identity. + */ + clientId?: string; +} + +/** + * Parameter supplied to Update Api Management Service. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiManagementServiceUpdateParameters extends ApimResource { + /** + * Properties of the API Management service. + */ + properties?: ApiManagementServiceUpdateProperties; + + /** + * SKU properties of the API Management service. + */ + sku?: ApiManagementServiceSkuProperties; + + /** + * Managed service identity of the Api Management service. + */ + identity?: ApiManagementServiceIdentity; + + /** + * ETag of the resource. + */ + @visibility(Lifecycle.Read) + etag?: string; + + /** + * A list of availability zones denoting where the resource needs to come from. + */ + zones?: string[]; +} + +/** + * Properties of an API Management service resource description. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiManagementServiceUpdateProperties + extends ApiManagementServiceBaseProperties { + /** + * Publisher email. + */ + @maxLength(100) + publisherEmail?: string; + + /** + * Publisher name. + */ + @maxLength(100) + publisherName?: string; +} + +/** + * Describes an available API Management SKU. + */ +model MigrateToStv2Contract { + /** + * Mode of Migration to stv2. Default is PreserveIp. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @OpenAPI.externalDocs("https://aka.ms/apim-migrate-stv2") + mode?: MigrateToStv2Mode; +} + +/** + * The response of the GetSsoToken operation. + */ +model ApiManagementServiceGetSsoTokenResult { + /** + * Redirect URL to the Publisher Portal containing the SSO token. + */ + redirectUri?: string; +} + +/** + * Parameters supplied to the CheckNameAvailability operation. + */ +model ApiManagementServiceCheckNameAvailabilityParameters { + /** + * The name to check for availability. + */ + name: string; +} + +/** + * Response of the CheckNameAvailability operation. + */ +model ApiManagementServiceNameAvailabilityResult { + /** + * True if the name is available and can be used to create a new API Management service; otherwise false. + */ + @visibility(Lifecycle.Read) + nameAvailable?: boolean; + + /** + * 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 is already in use, and direct them to select a different name. + */ + @visibility(Lifecycle.Read) + message?: string; + + /** + * Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable. + */ + reason?: NameAvailabilityReason; +} + +/** + * Response of the GetDomainOwnershipIdentifier operation. + */ +model ApiManagementServiceGetDomainOwnershipIdentifierResult { + /** + * The domain ownership identifier value. + */ + @visibility(Lifecycle.Read) + domainOwnershipIdentifier?: string; +} + +/** + * Parameter supplied to the Apply Network configuration operation. + */ +model ApiManagementServiceApplyNetworkConfigurationParameters { + /** + * Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required. + */ + location?: string; +} + +/** + * Paged Documentation list representation. + */ +model DocumentationCollection { + /** + * Page values. + */ + @pageItems + @visibility(Lifecycle.Read) + @OpenAPI.extension("x-ms-identifiers", #["name"]) + value?: DocumentationContract[]; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * Markdown documentation details. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model DocumentationContractProperties { + /** + * documentation title. + */ + title?: string; + + /** + * Markdown documentation content. + */ + content?: string; +} + +/** + * Documentation update contract details. + */ +model DocumentationUpdateContract { + /** + * Markdown Documentation details. + */ + properties?: DocumentationContractProperties; +} + +/** + * Paged email template list representation. + */ +model EmailTemplateCollection { + /** + * Page values. + */ + @pageItems + value?: EmailTemplateContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Email Template Contract properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model EmailTemplateContractProperties { + /** + * Subject of the Template. + */ + @maxLength(1000) + @minLength(1) + subject: string; + + /** + * Email Template Body. This should be a valid XDocument + */ + @minLength(1) + body: string; + + /** + * Title of the Template. + */ + title?: string; + + /** + * Description of the Email Template. + */ + description?: string; + + /** + * Whether the template is the default template provided by API Management or has been edited. + */ + @visibility(Lifecycle.Read) + isDefault?: boolean; + + /** + * Email Template Parameter values. + */ + @OpenAPI.extension("x-ms-identifiers", #["title"]) + parameters?: EmailTemplateParametersContractProperties[]; +} + +/** + * Email Template Parameter contract. + */ +model EmailTemplateParametersContractProperties { + /** + * Template parameter name. + */ + @maxLength(256) + @minLength(1) + @pattern("^[A-Za-z0-9-._]+$") + name?: string; + + /** + * Template parameter title. + */ + @maxLength(4096) + @minLength(1) + title?: string; + + /** + * Template parameter description. + */ + @maxLength(256) + @minLength(1) + @pattern("^[A-Za-z0-9-._]+$") + description?: string; +} + +/** + * Email Template update Parameters. + */ +model EmailTemplateUpdateParameters { + /** + * Email Template Update contract properties. + */ + properties?: EmailTemplateUpdateParameterProperties; +} + +/** + * Email Template Update Contract properties. + */ +model EmailTemplateUpdateParameterProperties { + /** + * Subject of the Template. + */ + @maxLength(1000) + @minLength(1) + subject?: string; + + /** + * Title of the Template. + */ + title?: string; + + /** + * Description of the Email Template. + */ + description?: string; + + /** + * Email Template Body. This should be a valid XDocument + */ + @minLength(1) + body?: string; + + /** + * Email Template Parameter values. + */ + @OpenAPI.extension("x-ms-identifiers", #["title"]) + parameters?: EmailTemplateParametersContractProperties[]; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model GatewayConfigConnectionBaseProperties { + /** + * The current provisioning state of the API Management gateway config connection + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + provisioningState?: string; + + /** + * The link to the API Management service workspace. + */ + sourceId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ApiManagement/service/workspaces"; + } + ]>; + + /** + * The default hostname of the data-plane gateway. + */ + @visibility(Lifecycle.Read) + defaultHostname?: string; + + /** + * The hostnames of the data-plane gateway to which requests can be sent. + */ + hostnames?: string[]; +} + +/** + * Paged Gateway list representation. + */ +model GatewayCollection { + /** + * Page values. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: GatewayContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * Properties of the Gateway contract. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model GatewayContractProperties { + /** + * Gateway location. + */ + locationData?: ResourceLocationDataContract; + + /** + * Gateway description + */ + @maxLength(1000) + description?: string; +} + +/** + * Resource location data properties. + */ +model ResourceLocationDataContract { + /** + * A canonical name for the geographic or physical location. + */ + @maxLength(256) + name: string; + + /** + * The city or locality where the resource is located. + */ + @maxLength(256) + city?: string; + + /** + * The district, state, or province where the resource is located. + */ + @maxLength(256) + district?: string; + + /** + * The country or region where the resource is located. + */ + @maxLength(256) + countryOrRegion?: string; +} + +/** + * Gateway authentication keys. + */ +model GatewayKeysContract { + /** + * Primary gateway key. + */ + primary?: string; + + /** + * Secondary gateway key. + */ + secondary?: string; +} + +/** + * Gateway key regeneration request contract properties. + */ +model GatewayKeyRegenerationRequestContract { + /** + * The Key being regenerated. + */ + keyType: KeyType; +} + +/** + * Gateway token request contract properties. + */ +model GatewayTokenRequestContract { + /** + * The Key to be used to generate gateway token. + */ + keyType: KeyType = KeyType.primary; + + /** + * The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expiry: utcDateTime; +} + +/** + * Gateway access token. + */ +model GatewayTokenContract { + /** + * Shared Access Authentication token value for the Gateway. + */ + value?: string; +} + +/** + * Paged Gateway hostname configuration list representation. + */ +model GatewayHostnameConfigurationCollection { + /** + * Page values. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: GatewayHostnameConfigurationContract[]; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * Gateway hostname configuration details. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model GatewayHostnameConfigurationContractProperties { + /** + * Hostname value. Supports valid domain name, partial or full wildcard + */ + hostname?: string; + + /** + * Identifier of Certificate entity that will be used for TLS connection establishment + */ + certificateId?: string; + + /** + * Determines whether gateway requests client certificate + */ + negotiateClientCertificate?: boolean; + + /** + * Specifies if TLS 1.0 is supported + */ + tls10Enabled?: boolean; + + /** + * Specifies if TLS 1.1 is supported + */ + tls11Enabled?: boolean; + + /** + * Specifies if HTTP/2.0 is supported + */ + http2Enabled?: boolean; +} + +/** + * Association entity details. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AssociationContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Association entity contract properties. + */ + properties?: AssociationContractProperties; +} + +/** + * Association entity contract properties. + */ +model AssociationContractProperties { + /** + * Provisioning state. + */ + provisioningState?: "created"; +} + +/** + * Paged Gateway certificate authority list representation. + */ +model GatewayCertificateAuthorityCollection { + /** + * Page values. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: GatewayCertificateAuthorityContract[]; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * Gateway certificate authority details. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model GatewayCertificateAuthorityContractProperties { + /** + * Determines whether certificate authority is trusted. + */ + isTrusted?: boolean; +} + +/** + * List debug credentials properties. + */ +model GatewayListDebugCredentialsContract { + /** + * Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used. + */ + credentialsExpireAfter?: duration; + + /** + * Purposes of debug credential. + */ + purposes: GatewayListDebugCredentialsContractPurpose[]; + + /** + * Full resource Id of an API. + */ + apiId: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ApiManagement/service/apis"; + }, + { + type: "Microsoft.ApiManagement/service/workspaces/apis"; + } + ]>; +} + +/** + * Gateway debug credentials. + */ +model GatewayDebugCredentialsContract { + /** + * Gateway debug token. + */ + @secret + token?: string; +} + +/** + * List trace properties. + */ +model GatewayListTraceContract { + /** + * Trace id. + */ + traceId?: string; +} + +/** + * Paged Group list representation. + */ +model GroupCollection { + /** + * Page values. + */ + @pageItems + value?: GroupContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Group contract Properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model GroupContractProperties { + /** + * Group name. + */ + @maxLength(300) + @minLength(1) + displayName: string; + + /** + * Group description. Can contain HTML formatting tags. + */ + @maxLength(1000) + description?: string; + + /** + * true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. + */ + @visibility(Lifecycle.Read) + builtIn?: boolean; + + /** + * Group type. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + type?: GroupType; + + /** + * For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. + */ + externalId?: string; +} + +/** + * Parameters supplied to the Create Group operation. + */ +model GroupCreateParameters { + /** + * Properties supplied to Create Group operation. + */ + properties?: GroupCreateParametersProperties; +} + +/** + * Parameters supplied to the Create Group operation. + */ +model GroupCreateParametersProperties { + /** + * Group name. + */ + @maxLength(300) + @minLength(1) + displayName: string; + + /** + * Group description. + */ + description?: string; + + /** + * Group type. + */ + type?: GroupType; + + /** + * Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. + */ + externalId?: string; +} + +/** + * Parameters supplied to the Update Group operation. + */ +model GroupUpdateParameters { + /** + * Group entity update contract properties. + */ + properties?: GroupUpdateParametersProperties; +} + +/** + * Parameters supplied to the Update Group operation. + */ +model GroupUpdateParametersProperties { + /** + * Group name. + */ + @maxLength(300) + @minLength(1) + displayName?: string; + + /** + * Group description. + */ + description?: string; + + /** + * Group type. + */ + type?: GroupType; + + /** + * Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. + */ + externalId?: string; +} + +/** + * Paged Users list representation. + */ +model UserCollection { + /** + * Page values. + */ + @pageItems + value?: UserContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * User profile. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model UserContractProperties extends UserEntityBaseParameters { + /** + * First name. + */ + firstName?: string; + + /** + * Last name. + */ + lastName?: string; + + /** + * Email address. + */ + email?: string; + + /** + * Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + registrationDate?: utcDateTime; + + /** + * Collection of groups user is part of. + */ + @visibility(Lifecycle.Read) + @OpenAPI.extension("x-ms-identifiers", #["displayName"]) + groups?: GroupContractProperties[]; +} + +/** + * User Entity Base Parameters set. + */ +model UserEntityBaseParameters { + /** + * Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. + */ + state?: UserState = UserState.active; + + /** + * Optional note about a user set by the administrator. + */ + note?: string; + + /** + * Collection of user identities. + */ + identities?: UserIdentityContract[]; +} + +/** + * User identity details. + */ +model UserIdentityContract { + /** + * Identity provider name. + */ + provider?: string; + + /** + * Identifier value within provider. + */ + id?: string; +} + +/** + * List of all the Identity Providers configured on the service instance. + */ +model IdentityProviderList { + /** + * Identity Provider configuration values. + */ + @pageItems + value?: IdentityProviderContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model IdentityProviderContractProperties + extends IdentityProviderBaseParameters { + /** + * Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. + */ + @minLength(1) + clientId: string; + + /** + * Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. + */ + @minLength(1) + @secret + clientSecret?: string; + + /** + * Certificate full resource ID used in external Identity Provider + */ + certificateId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ApiManagement/service/certificates"; + } + ]>; +} + +/** + * Identity Provider Base Parameter Properties. + */ +model IdentityProviderBaseParameters { + /** + * Identity Provider Type identifier. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + type?: IdentityProviderType; + + /** + * The TenantId to use instead of Common when logging into Active Directory + */ + signinTenant?: string; + + /** + * List of Allowed Tenants when configuring Azure Active Directory login. + */ + @maxItems(32) + allowedTenants?: string[]; + + /** + * OpenID Connect discovery endpoint hostname for AAD or AAD B2C. + */ + authority?: string; + + /** + * Signup Policy Name. Only applies to AAD B2C Identity Provider. + */ + @minLength(1) + signupPolicyName?: string; + + /** + * Signin Policy Name. Only applies to AAD B2C Identity Provider. + */ + @minLength(1) + signinPolicyName?: string; + + /** + * Profile Editing Policy Name. Only applies to AAD B2C Identity Provider. + */ + @minLength(1) + profileEditingPolicyName?: string; + + /** + * Password Reset Policy Name. Only applies to AAD B2C Identity Provider. + */ + @minLength(1) + passwordResetPolicyName?: string; + + /** + * The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider. + */ + @maxLength(16) + @minLength(0) + clientLibrary?: string; +} + +/** + * Identity Provider details. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model IdentityProviderCreateContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Identity Provider contract properties. + */ + properties?: IdentityProviderCreateContractProperties; +} + +/** + * The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model IdentityProviderCreateContractProperties + extends IdentityProviderBaseParameters { + /** + * Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. + */ + @minLength(1) + clientId: string; + + /** + * Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. + */ + @minLength(1) + @secret + clientSecret: string; + + /** + * Certificate full resource ID used in external Identity Provider + */ + certificateId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ApiManagement/service/certificates"; + } + ]>; +} + +/** + * Parameters supplied to update Identity Provider + */ +model IdentityProviderUpdateParameters { + /** + * Identity Provider update properties. + */ + properties?: IdentityProviderUpdateProperties; +} + +/** + * Parameters supplied to the Update Identity Provider operation. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model IdentityProviderUpdateProperties extends IdentityProviderBaseParameters { + /** + * Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. + */ + @minLength(1) + clientId?: string; + + /** + * Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. + */ + @minLength(1) + @secret + clientSecret?: string; + + /** + * Certificate full resource ID used in external Identity Provider + */ + certificateId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ApiManagement/service/certificates"; + } + ]>; +} + +/** + * Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + */ +model ClientSecretContract { + /** + * Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + */ + @secret + clientSecret?: string; +} + +/** + * Paged Logger list representation. + */ +model LoggerCollection { + /** + * Logger values. + */ + @pageItems + value?: LoggerContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model LoggerContractProperties { + /** + * Logger type. + */ + loggerType: LoggerType; + + /** + * Logger description. + */ + @maxLength(256) + description?: string; + + /** + * The name and SendRule connection string of the event hub for azureEventHub logger. + * Instrumentation key for applicationInsights logger. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + credentials?: Record; + + /** + * Whether records are buffered in the logger before publishing. Default is assumed to be true. + */ + isBuffered?: boolean; + + /** + * Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). + */ + resourceId?: string; +} + +/** + * Logger update contract. + */ +model LoggerUpdateContract { + /** + * Logger entity update contract properties. + */ + properties?: LoggerUpdateParameters; +} + +/** + * Parameters supplied to the Update Logger operation. + */ +model LoggerUpdateParameters { + /** + * Logger type. + */ + loggerType?: LoggerType; + + /** + * Logger description. + */ + description?: string; + + /** + * Logger credentials. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + credentials?: Record; + + /** + * Whether records are buffered in the logger before publishing. Default is assumed to be true. + */ + isBuffered?: boolean; +} + +/** + * Paged NamedValue list representation. + */ +model NamedValueCollection { + /** + * Page values. + */ + @pageItems + value?: NamedValueContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * NamedValue Contract properties. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model NamedValueContractProperties extends NamedValueEntityBaseParameters { + /** + * Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. + */ + @maxLength(256) + @minLength(1) + @pattern("^[A-Za-z0-9-._]+$") + displayName: string; + + /** + * Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. + */ + @maxLength(4096) + value?: string; + + /** + * KeyVault location details of the namedValue. + */ + keyVault?: KeyVaultContractProperties; + + /** + * The provisioning state + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + provisioningState?: string; +} + +/** + * NamedValue Entity Base Parameters set. + */ +model NamedValueEntityBaseParameters { + /** + * Optional tags that when provided can be used to filter the NamedValue list. + */ + @maxItems(32) + tags?: string[]; + + /** + * Determines whether the value is a secret and should be encrypted or not. Default value is false. + */ + secret?: boolean; +} + +/** + * NamedValue details. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model NamedValueCreateContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * NamedValue entity contract properties for PUT operation. + */ + properties?: NamedValueCreateContractProperties; +} + +/** + * NamedValue Contract properties. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model NamedValueCreateContractProperties + extends NamedValueEntityBaseParameters { + /** + * Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. + */ + @maxLength(256) + @minLength(1) + @pattern("^[A-Za-z0-9-._]+$") + displayName: string; + + /** + * Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. + */ + @maxLength(4096) + value?: string; + + /** + * KeyVault location details of the namedValue. + */ + keyVault?: KeyVaultContractCreateProperties; +} + +/** + * NamedValue update Parameters. + */ +model NamedValueUpdateParameters { + /** + * NamedValue entity Update contract properties. + */ + properties?: NamedValueUpdateParameterProperties; +} + +/** + * NamedValue Contract properties. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model NamedValueUpdateParameterProperties + extends NamedValueEntityBaseParameters { + /** + * Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. + */ + @maxLength(256) + @minLength(1) + @pattern("^[A-Za-z0-9-._]+$") + displayName?: string; + + /** + * Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. + */ + @maxLength(4096) + @minLength(1) + value?: string; + + /** + * KeyVault location details of the namedValue. + */ + keyVault?: KeyVaultContractCreateProperties; +} + +/** + * Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + */ +model NamedValueSecretContract { + /** + * This is secret value of the NamedValue entity. + */ + value?: string; +} + +/** + * Network Status in the Location + */ +model NetworkStatusContractByLocation { + /** + * Location of service + */ + @minLength(1) + location?: string; + + /** + * Network status in Location + */ + networkStatus?: NetworkStatusContract; +} + +/** + * Network Status details. + */ +model NetworkStatusContract { + /** + * Gets the list of DNS servers IPV4 addresses. + */ + dnsServers: string[]; + + /** + * Gets the list of Connectivity Status to the Resources on which the service depends upon. + */ + @OpenAPI.extension("x-ms-identifiers", #["name", "resourceType"]) + connectivityStatus: ConnectivityStatusContract[]; +} + +/** + * Details about connectivity to a resource. + */ +model ConnectivityStatusContract { + /** + * The hostname of the resource which the service depends on. This can be the database, storage or any other azure resource on which the service depends upon. + */ + @minLength(1) + name: string; + + /** + * Resource Connectivity Status Type identifier. + */ + status: ConnectivityStatusType; + + /** + * Error details of the connectivity to the resource. + */ + error?: string; + + /** + * The date when the resource connectivity status was last updated. This status should be updated every 15 minutes. If this status has not been updated, then it means that the service has lost network connectivity to the resource, from inside the Virtual Network.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + lastUpdated: utcDateTime; + + /** + * The date when the resource connectivity status last Changed from success to failure or vice-versa. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + lastStatusChange: utcDateTime; + + /** + * Resource Type. + */ + resourceType: string; + + /** + * Whether this is optional. + */ + isOptional: boolean; +} + +/** + * Paged Notification list representation. + */ +model NotificationCollection { + /** + * Page values. + */ + @pageItems + value?: NotificationContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Notification Contract properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model NotificationContractProperties { + /** + * Title of the Notification. + */ + @maxLength(1000) + @minLength(1) + title: string; + + /** + * Description of the Notification. + */ + description?: string; + + /** + * Recipient Parameter values. + */ + recipients?: RecipientsContractProperties; +} + +/** + * Notification Parameter contract. + */ +model RecipientsContractProperties { + /** + * List of Emails subscribed for the notification. + */ + emails?: string[]; + + /** + * List of Users subscribed for the notification. + */ + users?: string[]; +} + +/** + * Paged Recipient User list representation. + */ +model RecipientUserCollection { + /** + * Page values. + */ + value?: RecipientUserContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + nextLink?: string; +} + +/** + * Recipient User details. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model RecipientUserContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Recipient User entity contract properties. + */ + properties?: RecipientUsersContractProperties; +} + +/** + * Recipient User Contract Properties. + */ +model RecipientUsersContractProperties { + /** + * API Management UserId subscribed to notification. + */ + userId?: string; +} + +/** + * Paged Recipient User list representation. + */ +model RecipientEmailCollection { + /** + * Page values. + */ + value?: RecipientEmailContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + nextLink?: string; +} + +/** + * Recipient Email details. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model RecipientEmailContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Recipient Email contract properties. + */ + properties?: RecipientEmailContractProperties; +} + +/** + * Recipient Email Contract Properties. + */ +model RecipientEmailContractProperties { + /** + * User Email subscribed to notification. + */ + email?: string; +} + +/** + * Paged OpenIdProviders list representation. + */ +model OpenIdConnectProviderCollection { + /** + * Page values. + */ + @pageItems + value?: OpenidConnectProviderContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * OpenID Connect Providers Contract. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model OpenidConnectProviderContractProperties { + /** + * User-friendly OpenID Connect Provider name. + */ + @maxLength(50) + displayName: string; + + /** + * User-friendly description of OpenID Connect Provider. + */ + description?: string; + + /** + * Metadata endpoint URI. + */ + metadataEndpoint: string; + + /** + * Client ID of developer console which is the client application. + */ + clientId: string; + + /** + * Client Secret of developer console which is the client application. + */ + @secret + clientSecret?: string; + + /** + * If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided. + */ + useInTestConsole?: boolean; + + /** + * If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided. + */ + useInApiDocumentation?: boolean; +} + +/** + * Parameters supplied to the Update OpenID Connect Provider operation. + */ +model OpenidConnectProviderUpdateContract { + /** + * OpenId Connect Provider Update contract properties. + */ + properties?: OpenidConnectProviderUpdateContractProperties; +} + +/** + * Parameters supplied to the Update OpenID Connect Provider operation. + */ +model OpenidConnectProviderUpdateContractProperties { + /** + * User-friendly OpenID Connect Provider name. + */ + @maxLength(50) + displayName?: string; + + /** + * User-friendly description of OpenID Connect Provider. + */ + description?: string; + + /** + * Metadata endpoint URI. + */ + metadataEndpoint?: string; + + /** + * Client ID of developer console which is the client application. + */ + clientId?: string; + + /** + * Client Secret of developer console which is the client application. + */ + @secret + clientSecret?: string; + + /** + * If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided. + */ + useInTestConsole?: boolean; + + /** + * If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided. + */ + useInApiDocumentation?: boolean; +} + +/** + * Collection of Outbound Environment Endpoints + */ +model OutboundEnvironmentEndpointList { + /** + * Collection of resources. + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + value: OutboundEnvironmentEndpoint[]; + + /** + * Link to next page of resources. + */ + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * Endpoints accessed for a common purpose that the Api Management Service requires outbound network access to. + */ +model OutboundEnvironmentEndpoint { + /** + * The type of service accessed by the Api Management Service, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory. + */ + category?: string; + + /** + * The endpoints that the Api Management Service reaches the service at. + */ + @OpenAPI.extension("x-ms-identifiers", #["domainName"]) + endpoints?: EndpointDependency[]; +} + +/** + * A domain name that a service is reached at. + */ +model EndpointDependency { + /** + * The domain name of the dependency. + */ + domainName?: string; + + /** + * The Ports used when connecting to DomainName. + */ + @OpenAPI.extension("x-ms-identifiers", #["region", "port"]) + endpointDetails?: EndpointDetail[]; +} + +/** + * Current TCP connectivity information from the Api Management Service to a single endpoint. + */ +model EndpointDetail { + /** + * The port an endpoint is connected to. + */ + port?: int32; + + /** + * The region of the dependency. + */ + region?: string; +} + +/** + * Descriptions of API Management policies. + */ +model PolicyDescriptionCollection { + /** + * Descriptions of API Management policies. + */ + value?: PolicyDescriptionContract[]; + + /** + * Total record count number. + */ + count?: int64; +} + +/** + * Policy description details. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PolicyDescriptionContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Policy description contract properties. + */ + properties?: PolicyDescriptionContractProperties; +} + +/** + * Policy description properties. + */ +model PolicyDescriptionContractProperties { + /** + * Policy description. + */ + @visibility(Lifecycle.Read) + description?: string; + + /** + * Binary OR value of the Snippet scope. + */ + @visibility(Lifecycle.Read) + scope?: int64; +} + +/** + * The response of the get policy fragments operation. + */ +model PolicyFragmentCollection { + /** + * Policy fragment contract value. + */ + @pageItems + value?: PolicyFragmentContract[]; + + /** + * Total record count number. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Policy fragment contract properties. + */ +model PolicyFragmentContractProperties { + /** + * Contents of the policy fragment. + */ + value: string; + + /** + * Policy fragment description. + */ + @maxLength(1000) + @minLength(0) + description?: string; + + /** + * Format of the policy fragment content. + */ + format?: PolicyFragmentContentFormat = PolicyFragmentContentFormat.xml; + + /** + * The provisioning state + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + provisioningState?: string; +} + +/** + * A collection of resources. + */ +model ResourceCollection { + /** + * A collection of resources. + */ + value?: ResourceCollectionValueItem[]; + + /** + * Total record count number. + */ + count?: int64; + + /** + * Next page link if any. + */ + nextLink?: string; +} + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ResourceCollectionValueItem + extends Azure.ResourceManager.CommonTypes.ProxyResource {} + +/** + * The response of the get policy restrictions operation. + */ +model PolicyRestrictionCollection { + /** + * Page values. + */ + @pageItems + value?: PolicyRestrictionContract[]; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Policy restrictions contract properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PolicyRestrictionContractProperties { + /** + * Path to the policy document. + */ + scope?: string; + + /** + * Indicates if base policy should be enforced for the policy document. + */ + requireBase?: PolicyRestrictionRequireBase = PolicyRestrictionRequireBase.`false`; +} + +/** + * Policy restriction contract details. + */ +model PolicyRestrictionUpdateContract { + /** + * Properties of the Policy Restriction. + */ + properties?: PolicyRestrictionContractProperties; +} + +/** + * Long Running Git Operation Results. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model OperationResultContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Properties of the Operation Contract. + */ + properties?: OperationResultContractProperties; +} + +/** + * Operation Result. + */ +model OperationResultContractProperties { + /** + * Operation result identifier. + */ + id?: string; + + /** + * Status of an async operation. + */ + status?: AsyncOperationStatus; + + /** + * Start time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + started?: utcDateTime; + + /** + * Last update time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + updated?: utcDateTime; + + /** + * Optional result info. + */ + resultInfo?: string; + + /** + * Error Body Contract + */ + error?: ErrorResponseBody; + + /** + * This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation. + */ + @visibility(Lifecycle.Read) + @OpenAPI.extension("x-ms-identifiers", #["objectKey"]) + actionLog?: OperationResultLogItemContract[]; +} + +/** + * Error Body contract. + */ +model ErrorResponseBody { + /** + * Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. + */ + code?: string; + + /** + * Human-readable representation of the error. + */ + message?: string; + + /** + * The list of invalid fields send in request, in case of validation error. + */ + @OpenAPI.extension("x-ms-identifiers", #["message", "target"]) + details?: ErrorFieldContract[]; +} + +/** + * Error Field contract. + */ +model ErrorFieldContract { + /** + * Property level error code. + */ + code?: string; + + /** + * Human-readable representation of property-level error. + */ + message?: string; + + /** + * Property name. + */ + target?: string; +} + +/** + * Log of the entity being created, updated or deleted. + */ +model OperationResultLogItemContract { + /** + * The type of entity contract. + */ + objectType?: string; + + /** + * Action like create/update/delete. + */ + action?: string; + + /** + * Identifier of the entity being created/updated/deleted. + */ + objectKey?: string; +} + +/** + * The collection of the developer portal configurations. + */ +model PortalConfigCollection { + /** + * The developer portal configurations. + */ + @pageItems + value?: PortalConfigContract[]; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * The developer portal configuration contract properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PortalConfigProperties { + /** + * Enable or disable Basic authentication method. + */ + enableBasicAuth?: boolean = true; + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + signin?: PortalConfigPropertiesSignin; + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + signup?: PortalConfigPropertiesSignup; + + /** + * The developer portal delegation settings. + */ + delegation?: PortalConfigDelegationProperties; + + /** + * The developer portal Cross-Origin Resource Sharing (CORS) settings. + */ + cors?: PortalConfigCorsProperties; + + /** + * The developer portal Content Security Policy (CSP) settings. + */ + csp?: PortalConfigCspProperties; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PortalConfigPropertiesSignin { + /** + * Redirect anonymous users to the sign-in page. + */ + require?: boolean = false; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PortalConfigPropertiesSignup { + /** + * Terms of service settings. + */ + termsOfService?: PortalConfigTermsOfServiceProperties; +} + +/** + * Terms of service contract properties. + */ +model PortalConfigTermsOfServiceProperties { + /** + * A terms of service text. + */ + text?: string; + + /** + * Ask user for consent to the terms of service. + */ + requireConsent?: boolean = false; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PortalConfigDelegationProperties { + /** + * Enable or disable delegation for user registration. + */ + delegateRegistration?: boolean = false; + + /** + * Enable or disable delegation for product subscriptions. + */ + delegateSubscription?: boolean = false; + + /** + * A delegation endpoint URL. + */ + delegationUrl?: string; + + /** + * A base64-encoded validation key to ensure requests originate from Azure API Management service. + */ + @secret + validationKey?: string; +} + +/** + * The developer portal Cross-Origin Resource Sharing (CORS) settings. + */ +model PortalConfigCorsProperties { + /** + * Allowed origins, e.g. `https://trusted.com`. + */ + allowedOrigins?: string[]; +} + +/** + * The developer portal Content Security Policy (CSP) settings. + */ +model PortalConfigCspProperties { + /** + * The mode of the developer portal Content Security Policy (CSP). + */ + mode?: PortalSettingsCspMode = PortalSettingsCspMode.disabled; + + /** + * The URLs used by the browser to report CSP violations. + */ + reportUri?: string[]; + + /** + * Allowed sources, e.g. `*.trusted.com`, `trusted.com`, `https://`. + */ + allowedSources?: string[]; +} + +/** + * Paged ClientApplication list representation. + */ +model ClientApplicationCollection { + /** + * Page values. + */ + @pageItems + value?: ClientApplicationContract[]; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Client Application Entity Properties + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ClientApplicationContractProperties { + /** + * Client application name. + */ + @maxLength(300) + @minLength(0) + displayName: string; + + /** + * Client application description. + */ + @maxLength(1000) + @minLength(0) + description?: string; + + /** + * A resource identifier for the user who owns the application. + */ + ownerId: string; + + /** + * Microsoft EntraID Application ID (Client ID). This is the value that is used to identify the application when it is requesting access tokens from Microsoft EntraID. This property is read-only and will be set by the system when the application is created. + */ + @visibility(Lifecycle.Read) + entraApplicationId?: string; + + /** + * Tenant ID is a unique identifier (a GUID) for an organization directory in Microsoft’s cloud. It’s used to identify tenants across Microsoft services. + */ + @visibility(Lifecycle.Read) + entraTenantId?: string; + + /** + * Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks. + */ + @visibility(Lifecycle.Read) + state?: ClientApplicationState; +} + +/** + * Specifies client application secrets needed to authorize applications API calls + */ +model ClientApplicationSecretsContract { + /** + * Microsoft EntraID client application secrets + */ + entra?: ClientApplicationSecretsContractEntra; +} + +/** + * Microsoft EntraID client application secrets + */ +model ClientApplicationSecretsContractEntra { + /** + * EntraID client application secret + */ + @secret + clientSecret?: string; + + /** + * EntraID client application secret expiration date. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expiresAt?: utcDateTime; +} + +/** + * Paged ClientApplicationProductLinkContract list representation. + */ +model ClientApplicationProductLinkCollection { + /** + * Page values. + */ + @pageItems + value?: ClientApplicationProductLinkContract[]; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ClientApplicationProductLinkContractProperties { + /** + * The unique resource identifier of the Product. + */ + productId: string; +} + +/** + * Paged list of portal revisions. + */ +model PortalRevisionCollection { + /** + * Collection of portal revisions. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: PortalRevisionContract[]; + + /** + * Next page link, if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PortalRevisionContractProperties { + /** + * Portal revision description. + */ + @maxLength(2000) + description?: string; + + /** + * Portal revision publishing status details. + */ + @visibility(Lifecycle.Read) + @maxLength(2000) + statusDetails?: string; + + /** + * Status of the portal's revision. + */ + @visibility(Lifecycle.Read) + status?: PortalRevisionStatus; + + /** + * Indicates if the portal's revision is public. + */ + isCurrent?: boolean; + + /** + * Portal's revision creation date and time. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + createdDateTime?: utcDateTime; + + /** + * Last updated date and time. + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + updatedDateTime?: utcDateTime; + + /** + * The provisioning state + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + provisioningState?: string; +} + +/** + * Descriptions of API Management policies. + */ +model PortalSettingsCollection { + /** + * Descriptions of API Management policies. + */ + value?: PortalSettingsContract[]; + + /** + * Total record count number. + */ + count?: int64; +} + +/** + * Portal Settings for the Developer Portal. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PortalSettingsContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Portal Settings contract properties. + */ + properties?: PortalSettingsContractProperties; +} + +/** + * Sign-in settings contract properties. + */ +model PortalSettingsContractProperties { + /** + * A delegation Url. + */ + url?: string; + + /** + * A base64-encoded validation key to validate, that a request is coming from Azure API Management. + */ + @secret + validationKey?: string; + + /** + * Subscriptions delegation settings. + */ + subscriptions?: SubscriptionsDelegationSettingsProperties; + + /** + * User registration delegation settings. + */ + userRegistration?: RegistrationDelegationSettingsProperties; + + /** + * Redirect Anonymous users to the Sign-In page. + */ + enabled?: boolean; + + /** + * Terms of service contract properties. + */ + termsOfService?: TermsOfServiceProperties; +} + +/** + * Subscriptions delegation settings properties. + */ +model SubscriptionsDelegationSettingsProperties { + /** + * Enable or disable delegation for subscriptions. + */ + enabled?: boolean; +} + +/** + * User registration delegation settings properties. + */ +model RegistrationDelegationSettingsProperties { + /** + * Enable or disable delegation for user registration. + */ + enabled?: boolean; +} + +/** + * Terms of service contract properties. + */ +model TermsOfServiceProperties { + /** + * A terms of service text. + */ + text?: string; + + /** + * Display terms of service during a sign-up process. + */ + enabled?: boolean; + + /** + * Ask user for consent to the terms of service. + */ + consentRequired?: boolean; +} + +/** + * Sign-in settings contract properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PortalSigninSettingProperties { + /** + * Redirect Anonymous users to the Sign-In page. + */ + enabled?: boolean; +} + +/** + * Sign-up settings contract properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PortalSignupSettingsProperties { + /** + * Allow users to sign up on a developer portal. + */ + enabled?: boolean; + + /** + * Terms of service contract properties. + */ + termsOfService?: TermsOfServiceProperties; +} + +/** + * Delegation settings contract properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PortalDelegationSettingsProperties { + /** + * A delegation Url. + */ + url?: string; + + /** + * A base64-encoded validation key to validate, that a request is coming from Azure API Management. + */ + @secret + validationKey?: string; + + /** + * Subscriptions delegation settings. + */ + subscriptions?: SubscriptionsDelegationSettingsProperties; + + /** + * User registration delegation settings. + */ + userRegistration?: RegistrationDelegationSettingsProperties; +} + +/** + * Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + */ +model PortalSettingValidationKeyContract { + /** + * This is secret value of the validation key in portal settings. + */ + @secret + validationKey?: string; +} + +/** + * A request to approve or reject a private endpoint connection + */ +model PrivateEndpointConnectionRequest { + /** + * Private Endpoint Connection Resource Id. + */ + id?: string; + + /** + * The connection state of the private endpoint connection. + */ + properties?: PrivateEndpointConnectionRequestProperties; +} + +/** + * The connection state of the private endpoint connection. + */ +model PrivateEndpointConnectionRequestProperties { + /** + * A collection of information about the state of the connection between service consumer and provider. + */ + privateLinkServiceConnectionState?: Azure.ResourceManager.CommonTypes.PrivateLinkServiceConnectionState; +} + +/** + * Product Update parameters. + */ +model ProductUpdateParameters { + /** + * Product entity Update contract properties. + */ + properties?: ProductUpdateProperties; +} + +/** + * Parameters supplied to the Update Product operation. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ProductUpdateProperties extends ProductEntityBaseParameters { + /** + * Product name. + */ + @maxLength(300) + @minLength(1) + displayName?: string; +} + +/** + * Paged Subscriptions list representation. + */ +model SubscriptionCollection { + /** + * Page values. + */ + @pageItems + value?: SubscriptionContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Subscription details. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model SubscriptionContractProperties { + /** + * The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. + */ + ownerId?: string; + + /** + * Scope like /products/{productId} or /apis or /apis/{apiId}. + */ + scope: string; + + /** + * The name of the subscription, or null if the subscription has no name. + */ + @maxLength(100) + @minLength(0) + displayName?: string; + + /** + * Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. + */ + state: SubscriptionState; + + /** + * Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + @visibility(Lifecycle.Read) + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + createdDate?: utcDateTime; + + /** + * Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + startDate?: utcDateTime; + + /** + * Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expirationDate?: utcDateTime; + + /** + * Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + endDate?: utcDateTime; + + /** + * Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + notificationDate?: utcDateTime; + + /** + * Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. + */ + @maxLength(256) + @minLength(1) + @secret + primaryKey?: string; + + /** + * Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. + */ + @maxLength(256) + @minLength(1) + @secret + secondaryKey?: string; + + /** + * Optional subscription comment added by an administrator when the state is changed to the 'rejected'. + */ + stateComment?: string; + + /** + * Determines whether tracing is enabled + */ + allowTracing?: boolean; +} + +/** + * Paged Product-API link list representation. + */ +model ProductApiLinkCollection { + /** + * Page values. + */ + @pageItems + value?: ProductApiLinkContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Product-API link entity properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ProductApiLinkContractProperties { + /** + * Full resource Id of an API. + */ + apiId: string; +} + +/** + * Paged Product-group link list representation. + */ +model ProductGroupLinkCollection { + /** + * Page values. + */ + @pageItems + value?: ProductGroupLinkContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Product-group link entity properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ProductGroupLinkContractProperties { + /** + * Full resource Id of a group. + */ + groupId: string; +} + +/** + * Paged Quota Counter list representation. + */ +model QuotaCounterCollection { + /** + * Quota counter values. + */ + @OpenAPI.extension("x-ms-identifiers", #["counterKey", "periodKey"]) + value?: QuotaCounterContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + nextLink?: string; +} + +/** + * Quota counter details. + */ +model QuotaCounterContract { + /** + * The Key value of the Counter. Must not be empty. + */ + @minLength(1) + counterKey: string; + + /** + * Identifier of the Period for which the counter was collected. Must not be empty. + */ + @minLength(1) + periodKey: string; + + /** + * The date of the start of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + periodStartTime: utcDateTime; + + /** + * The date of the end of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + periodEndTime: utcDateTime; + + /** + * Quota Value Properties + */ + value?: QuotaCounterValueContractProperties; +} + +/** + * Quota counter value details. + */ +model QuotaCounterValueContractProperties { + /** + * Number of times Counter was called. + */ + callsCount?: int32; + + /** + * Data Transferred in KiloBytes. + */ + kbTransferred?: float64; +} + +/** + * Quota counter value details. + */ +model QuotaCounterValueUpdateContract { + /** + * Quota counter value details. + */ + properties?: QuotaCounterValueContractProperties; +} + +/** + * Lists Regions operation response details. + */ +model RegionListResult { + /** + * Lists of Regions. + */ + @pageItems + @OpenAPI.extension("x-ms-identifiers", #["name"]) + value?: RegionContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Region profile. + */ +model RegionContract { + /** + * Region name. + */ + @visibility(Lifecycle.Read) + name?: string; + + /** + * whether Region is the master region. + */ + isMasterRegion?: boolean; + + /** + * whether Region is deleted. + */ + isDeleted?: boolean; +} + +/** + * Paged Report records list representation. + */ +model ReportCollection { + /** + * Page values. + */ + @pageItems + @OpenAPI.extension("x-ms-identifiers", #["name", "userId"]) + value?: ReportRecordContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Report data. + */ +model ReportRecordContract { + /** + * Name depending on report endpoint specifies product, API, operation or developer name. + */ + name?: string; + + /** + * Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + timestamp?: utcDateTime; + + /** + * Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). + */ + interval?: string; + + /** + * Country to which this record data is related. + */ + country?: string; + + /** + * Country region to which this record data is related. + */ + region?: string; + + /** + * Zip code to which this record data is related. + */ + zip?: string; + + /** + * User identifier path. /users/{userId} + */ + @visibility(Lifecycle.Read) + userId?: string; + + /** + * Product identifier path. /products/{productId} + */ + @visibility(Lifecycle.Read) + productId?: string; + + /** + * API identifier path. /apis/{apiId} + */ + apiId?: string; + + /** + * Operation identifier path. /apis/{apiId}/operations/{operationId} + */ + operationId?: string; + + /** + * API region identifier. + */ + apiRegion?: string; + + /** + * Subscription identifier path. /subscriptions/{subscriptionId} + */ + subscriptionId?: string; + + /** + * Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect + */ + callCountSuccess?: int32; + + /** + * Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests + */ + callCountBlocked?: int32; + + /** + * Number of calls failed due to gateway or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600 + */ + callCountFailed?: int32; + + /** + * Number of other calls. + */ + callCountOther?: int32; + + /** + * Total number of calls. + */ + callCountTotal?: int32; + + /** + * Bandwidth consumed. + */ + bandwidth?: int64; + + /** + * Number of times when content was served from cache policy. + */ + cacheHitCount?: int32; + + /** + * Number of times content was fetched from backend. + */ + cacheMissCount?: int32; + + /** + * Average time it took to process request. + */ + apiTimeAvg?: float64; + + /** + * Minimum time it took to process request. + */ + apiTimeMin?: float64; + + /** + * Maximum time it took to process request. + */ + apiTimeMax?: float64; + + /** + * Average time it took to process request on backend. + */ + serviceTimeAvg?: float64; + + /** + * Minimum time it took to process request on backend. + */ + serviceTimeMin?: float64; + + /** + * Maximum time it took to process request on backend. + */ + serviceTimeMax?: float64; +} + +/** + * Paged Report records list representation. + */ +model RequestReportCollection { + /** + * Page values. + */ + @pageItems + @OpenAPI.extension("x-ms-identifiers", #["url"]) + value?: RequestReportRecordContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Request Report data. + */ +model RequestReportRecordContract { + /** + * API identifier path. /apis/{apiId} + */ + apiId?: string; + + /** + * Operation identifier path. /apis/{apiId}/operations/{operationId} + */ + operationId?: string; + + /** + * Product identifier path. /products/{productId} + */ + @visibility(Lifecycle.Read) + productId?: string; + + /** + * User identifier path. /users/{userId} + */ + @visibility(Lifecycle.Read) + userId?: string; + + /** + * The HTTP method associated with this request.. + */ + method?: string; + + /** + * The full URL associated with this request. + */ + url?: string; + + /** + * The client IP address associated with this request. + */ + ipAddress?: string; + + /** + * The HTTP status code received by the gateway as a result of forwarding this request to the backend. + */ + backendResponseCode?: string; + + /** + * The HTTP status code returned by the gateway. + */ + responseCode?: int32; + + /** + * The size of the response returned by the gateway. + */ + responseSize?: int32; + + /** + * The date and time when this request was received by the gateway in ISO 8601 format. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + timestamp?: utcDateTime; + + /** + * Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend. + */ + cache?: string; + + /** + * The total time it took to process this request. + */ + apiTime?: float64; + + /** + * he time it took to forward this request to the backend and get the response back. + */ + serviceTime?: float64; + + /** + * Azure region where the gateway that processed this request is located. + */ + apiRegion?: string; + + /** + * Subscription identifier path. /subscriptions/{subscriptionId} + */ + subscriptionId?: string; + + /** + * Request Identifier. + */ + requestId?: string; + + /** + * The size of this request.. + */ + requestSize?: int32; +} + +/** + * The response of the list schema operation. + */ +model GlobalSchemaCollection { + /** + * Global Schema Contract value. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: GlobalSchemaContract[]; + + /** + * Total record count number. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * Schema create or update contract Properties. + */ +model GlobalSchemaContractProperties { + /** + * Schema Type. Immutable. + */ + schemaType: SchemaType; + + /** + * Free-form schema entity description. + */ + description?: string; + + /** + * Json-encoded string for non json-based schema. + */ + #suppress "@azure-tools/typespec-azure-core/no-unknown" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + value?: unknown; + + /** + * Global Schema document object for json-based schema formats(e.g. json schema). + */ + #suppress "@azure-tools/typespec-azure-core/no-unknown" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + document?: unknown; + + /** + * The provisioning state + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + provisioningState?: string; +} + +/** + * Paged AccessInformation list representation. + */ +model TenantSettingsCollection { + /** + * Page values. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: TenantSettingsContract[]; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * Tenant access information contract of the API Management service. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TenantSettingsContractProperties { + /** + * Tenant settings + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + settings?: Record; +} + +/** + * The List Resource Skus operation response. + */ +model ApiManagementSkusResult { + /** + * The list of skus available for the subscription. + */ + @pageItems + @OpenAPI.extension("x-ms-identifiers", #["name", "resourceType"]) + value: ApiManagementSku[]; + + /** + * The URI to fetch the next page of Resource Skus. Call ListNext() with this URI to fetch the next page of Resource Skus + */ + @visibility(Lifecycle.Read) + @nextLink + nextLink?: string; +} + +/** + * Describes an available ApiManagement SKU. + */ +model ApiManagementSku { + /** + * The type of resource the SKU applies to. + */ + @visibility(Lifecycle.Read) + resourceType?: string; + + /** + * The name of SKU. + */ + @visibility(Lifecycle.Read) + name?: string; + + /** + * Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** + */ + @visibility(Lifecycle.Read) + tier?: string; + + /** + * The Size of the SKU. + */ + @visibility(Lifecycle.Read) + size?: string; + + /** + * The Family of this particular SKU. + */ + @visibility(Lifecycle.Read) + family?: string; + + /** + * The Kind of resources that are supported in this SKU. + */ + @visibility(Lifecycle.Read) + kind?: string; + + /** + * Specifies the number of virtual machines in the scale set. + */ + @visibility(Lifecycle.Read) + capacity?: ApiManagementSkuCapacity; + + /** + * The set of locations that the SKU is available. + */ + @visibility(Lifecycle.Read) + locations?: string[]; + + /** + * A list of locations and availability zones in those locations where the SKU is available. + */ + @visibility(Lifecycle.Read) + @OpenAPI.extension("x-ms-identifiers", #["location"]) + locationInfo?: ApiManagementSkuLocationInfo[]; + + /** + * The api versions that support this SKU. + */ + @visibility(Lifecycle.Read) + apiVersions?: string[]; + + /** + * Metadata for retrieving price info. + */ + @visibility(Lifecycle.Read) + @OpenAPI.extension("x-ms-identifiers", #["meterID"]) + costs?: ApiManagementSkuCosts[]; + + /** + * A name value pair to describe the capability. + */ + @visibility(Lifecycle.Read) + @OpenAPI.extension("x-ms-identifiers", #["name"]) + capabilities?: ApiManagementSkuCapabilities[]; + + /** + * The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. + */ + @visibility(Lifecycle.Read) + @OpenAPI.extension("x-ms-identifiers", #[]) + restrictions?: ApiManagementSkuRestrictions[]; +} + +/** + * Describes scaling information of a SKU. + */ +model ApiManagementSkuCapacity { + /** + * The minimum capacity. + */ + @visibility(Lifecycle.Read) + minimum?: int32; + + /** + * The maximum capacity that can be set. + */ + @visibility(Lifecycle.Read) + maximum?: int32; + + /** + * The default capacity. + */ + @visibility(Lifecycle.Read) + default?: int32; + + /** + * The scale type applicable to the sku. + */ + @visibility(Lifecycle.Read) + scaleType?: ApiManagementSkuCapacityScaleType; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiManagementSkuLocationInfo { + /** + * Location of the SKU + */ + @visibility(Lifecycle.Read) + location?: string; + + /** + * List of availability zones where the SKU is supported. + */ + @visibility(Lifecycle.Read) + zones?: string[]; + + /** + * Details of capabilities available to a SKU in specific zones. + */ + @visibility(Lifecycle.Read) + @OpenAPI.extension("x-ms-identifiers", #["name"]) + zoneDetails?: ApiManagementSkuZoneDetails[]; +} + +/** + * Describes The zonal capabilities of a SKU. + */ +model ApiManagementSkuZoneDetails { + /** + * The set of zones that the SKU is available in with the specified capabilities. + */ + @visibility(Lifecycle.Read) + name?: string[]; + + /** + * A list of capabilities that are available for the SKU in the specified list of zones. + */ + @visibility(Lifecycle.Read) + @OpenAPI.extension("x-ms-identifiers", #["name"]) + capabilities?: ApiManagementSkuCapabilities[]; +} + +/** + * Describes The SKU capabilities object. + */ +model ApiManagementSkuCapabilities { + /** + * An invariant to describe the feature. + */ + @visibility(Lifecycle.Read) + name?: string; + + /** + * An invariant if the feature is measured by quantity. + */ + @visibility(Lifecycle.Read) + value?: string; +} + +/** + * Describes metadata for retrieving price info. + */ +model ApiManagementSkuCosts { + /** + * Used for querying price from commerce. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @visibility(Lifecycle.Read) + meterID?: string; + + /** + * The multiplier is needed to extend the base metered cost. + */ + @visibility(Lifecycle.Read) + quantity?: int64; + + /** + * An invariant to show the extended unit. + */ + @visibility(Lifecycle.Read) + extendedUnit?: string; +} + +/** + * Describes scaling information of a SKU. + */ +model ApiManagementSkuRestrictions { + /** + * The type of restrictions. + */ + @visibility(Lifecycle.Read) + type?: ApiManagementSkuRestrictionsType; + + /** + * The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. + */ + @visibility(Lifecycle.Read) + values?: string[]; + + /** + * The information about the restriction where the SKU cannot be used. + */ + @visibility(Lifecycle.Read) + restrictionInfo?: ApiManagementSkuRestrictionInfo; + + /** + * The reason for restriction. + */ + @visibility(Lifecycle.Read) + reasonCode?: ApiManagementSkuRestrictionsReasonCode; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiManagementSkuRestrictionInfo { + /** + * Locations where the SKU is restricted + */ + @visibility(Lifecycle.Read) + locations?: string[]; + + /** + * List of availability zones where the SKU is restricted. + */ + @visibility(Lifecycle.Read) + zones?: string[]; +} + +/** + * Subscription create details. + */ +model SubscriptionCreateParameters { + /** + * Subscription contract properties. + */ + properties?: SubscriptionCreateParameterProperties; +} + +/** + * Parameters supplied to the Create subscription operation. + */ +model SubscriptionCreateParameterProperties { + /** + * User (user id path) for whom subscription is being created in form /users/{userId} + */ + ownerId?: string; + + /** + * Scope like /products/{productId} or /apis or /apis/{apiId}. + */ + scope: string; + + /** + * Subscription name. + */ + @maxLength(100) + @minLength(1) + displayName: string; + + /** + * Primary subscription key. If not specified during request key will be generated automatically. + */ + @maxLength(256) + @minLength(1) + primaryKey?: string; + + /** + * Secondary subscription key. If not specified during request key will be generated automatically. + */ + @maxLength(256) + @minLength(1) + secondaryKey?: string; + + /** + * Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. + */ + state?: SubscriptionState; + + /** + * Determines whether tracing can be enabled + */ + allowTracing?: boolean; +} + +/** + * Subscription update details. + */ +model SubscriptionUpdateParameters { + /** + * Subscription Update contract properties. + */ + properties?: SubscriptionUpdateParameterProperties; +} + +/** + * Parameters supplied to the Update subscription operation. + */ +model SubscriptionUpdateParameterProperties { + /** + * User identifier path: /users/{userId} + */ + ownerId?: string; + + /** + * Scope like /products/{productId} or /apis or /apis/{apiId} + */ + scope?: string; + + /** + * Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expirationDate?: utcDateTime; + + /** + * Subscription name. + */ + displayName?: string; + + /** + * Primary subscription key. + */ + @maxLength(256) + @minLength(1) + primaryKey?: string; + + /** + * Secondary subscription key. + */ + @maxLength(256) + @minLength(1) + secondaryKey?: string; + + /** + * Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. + */ + state?: SubscriptionState; + + /** + * Comments describing subscription state change by the administrator when the state is changed to the 'rejected'. + */ + stateComment?: string; + + /** + * Determines whether tracing can be enabled + */ + allowTracing?: boolean; +} + +/** + * Subscription keys. + */ +model SubscriptionKeysContract { + /** + * Subscription primary key. + */ + @maxLength(256) + @minLength(1) + primaryKey?: string; + + /** + * Subscription secondary key. + */ + @maxLength(256) + @minLength(1) + secondaryKey?: string; +} + +/** + * Parameters supplied to Create/Update Tag operations. + */ +model TagCreateUpdateParameters { + /** + * Properties supplied to Create Tag operation. + */ + properties?: TagContractProperties; +} + +/** + * Paged Tag-API link list representation. + */ +model TagApiLinkCollection { + /** + * Page values. + */ + @pageItems + value?: TagApiLinkContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Tag-API link entity properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TagApiLinkContractProperties { + /** + * Full resource Id of an API. + */ + apiId: string; +} + +/** + * Paged Tag-operation link list representation. + */ +model TagOperationLinkCollection { + /** + * Page values. + */ + @pageItems + value?: TagOperationLinkContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Tag-operation link entity properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TagOperationLinkContractProperties { + /** + * Full resource Id of an API operation. + */ + operationId: string; +} + +/** + * Paged Tag-product link list representation. + */ +model TagProductLinkCollection { + /** + * Page values. + */ + @pageItems + value?: TagProductLinkContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Tag-product link entity properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TagProductLinkContractProperties { + /** + * Full resource Id of a product. + */ + productId: string; +} + +/** + * Paged AccessInformation list representation. + */ +model AccessInformationCollection { + /** + * Page values. + */ + @pageItems + @visibility(Lifecycle.Read) + value?: AccessInformationContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + @visibility(Lifecycle.Read) + nextLink?: string; +} + +/** + * Tenant access information contract of the API Management service. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AccessInformationContractProperties { + /** + * Access Information type ('access' or 'gitAccess') + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + id?: string; + + /** + * Principal (User) Identifier. + */ + principalId?: string; + + /** + * Determines whether direct access is enabled. + */ + enabled?: boolean; +} + +/** + * Tenant access information update parameters. + */ +model AccessInformationCreateParameters { + /** + * Tenant access information update parameter properties. + */ + properties?: AccessInformationCreateParameterProperties; +} + +/** + * Tenant access information update parameters of the API Management service + */ +model AccessInformationCreateParameterProperties { + /** + * Principal (User) Identifier. + */ + principalId?: string; + + /** + * Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. + */ + @secret + primaryKey?: string; + + /** + * Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. + */ + @secret + secondaryKey?: string; + + /** + * Determines whether direct access is enabled. + */ + enabled?: boolean; +} + +/** + * Tenant access information update parameters. + */ +model AccessInformationUpdateParameters { + /** + * Tenant access information update parameter properties. + */ + properties?: AccessInformationUpdateParameterProperties; +} + +/** + * Tenant access information update parameters of the API Management service + */ +model AccessInformationUpdateParameterProperties { + /** + * Determines whether direct access is enabled. + */ + enabled?: boolean; +} + +/** + * Tenant access information contract of the API Management service. + */ +model AccessInformationSecretsContract { + /** + * Access Information type ('access' or 'gitAccess') + */ + id?: string; + + /** + * Principal (User) Identifier. + */ + principalId?: string; + + /** + * Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. + */ + @secret + primaryKey?: string; + + /** + * Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. + */ + @secret + secondaryKey?: string; + + /** + * Determines whether direct access is enabled. + */ + enabled?: boolean; +} + +/** + * Deploy Tenant Configuration Contract. + */ +model DeployConfigurationParameters { + /** + * Deploy Configuration Parameter contract properties. + */ + properties?: DeployConfigurationParameterProperties; +} + +/** + * Parameters supplied to the Deploy Configuration operation. + */ +model DeployConfigurationParameterProperties { + /** + * The name of the Git branch from which the configuration is to be deployed to the configuration database. + */ + branch: string; + + /** + * The value enforcing deleting subscriptions to products that are deleted in this update. + */ + force?: boolean; +} + +/** + * Save Tenant Configuration Contract details. + */ +model SaveConfigurationParameter { + /** + * Properties of the Save Configuration Parameters. + */ + properties?: SaveConfigurationParameterProperties; +} + +/** + * Parameters supplied to the Save Tenant Configuration operation. + */ +model SaveConfigurationParameterProperties { + /** + * The name of the Git branch in which to commit the current configuration snapshot. + */ + branch: string; + + /** + * The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten. + */ + force?: boolean; +} + +/** + * Result of Tenant Configuration Sync State. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model TenantConfigurationSyncStateContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Properties returned Tenant Configuration Sync State check. + */ + properties?: TenantConfigurationSyncStateContractProperties; +} + +/** + * Tenant Configuration Synchronization State. + */ +model TenantConfigurationSyncStateContractProperties { + /** + * The name of Git branch. + */ + branch?: string; + + /** + * The latest commit Id. + */ + commitId?: string; + + /** + * value indicating if last sync was save (true) or deploy (false) operation. + */ + isExport?: boolean; + + /** + * value indicating if last synchronization was later than the configuration change. + */ + isSynced?: boolean; + + /** + * value indicating whether Git configuration access is enabled. + */ + isGitEnabled?: boolean; + + /** + * The date of the latest synchronization. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + syncDate?: utcDateTime; + + /** + * The date of the latest configuration change. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + configurationChangeDate?: utcDateTime; + + /** + * Most recent tenant configuration operation identifier + */ + lastOperationId?: string; +} + +/** + * User create details. + */ +model UserCreateParameters { + /** + * User entity create contract properties. + */ + properties?: UserCreateParameterProperties; +} + +/** + * Parameters supplied to the Create User operation. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model UserCreateParameterProperties extends UserEntityBaseParameters { + /** + * Email address. Must not be empty and must be unique within the service instance. + */ + @maxLength(254) + @minLength(1) + email: string; + + /** + * First name. + */ + @maxLength(100) + @minLength(1) + firstName: string; + + /** + * Last name. + */ + @maxLength(100) + @minLength(1) + lastName: string; + + /** + * User Password. If no value is provided, a default password is generated. + */ + password?: string; + + /** + * Determines the type of application which send the create user request. Default is legacy portal. + */ + appType?: AppType; + + /** + * Determines the type of confirmation e-mail that will be sent to the newly created user. + */ + confirmation?: Confirmation; +} + +/** + * User update parameters. + */ +model UserUpdateParameters { + /** + * User entity update contract properties. + */ + properties?: UserUpdateParametersProperties; +} + +/** + * Parameters supplied to the Update User operation. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model UserUpdateParametersProperties extends UserEntityBaseParameters { + /** + * Email address. Must not be empty and must be unique within the service instance. + */ + @maxLength(254) + @minLength(1) + email?: string; + + /** + * User Password. + */ + password?: string; + + /** + * First name. + */ + @maxLength(100) + @minLength(1) + firstName?: string; + + /** + * Last name. + */ + @maxLength(100) + @minLength(1) + lastName?: string; +} + +/** + * Generate SSO Url operations response details. + */ +model GenerateSsoUrlResult { + /** + * Redirect Url containing the SSO URL value. + */ + value?: string; +} + +/** + * List of Users Identity list representation. + */ +model UserIdentityCollection { + /** + * User Identity values. + */ + @pageItems + value?: UserIdentityContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Get User Token parameters. + */ +model UserTokenParameters { + /** + * User Token Parameter contract properties. + */ + properties?: UserTokenParameterProperties; +} + +/** + * Parameters supplied to the Get User Token operation. + */ +model UserTokenParameterProperties { + /** + * The Key to be used to generate token for user. + */ + keyType: KeyType = KeyType.primary; + + /** + * The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + expiry: utcDateTime; +} + +/** + * Get User Token response details. + */ +model UserTokenResult { + /** + * Shared Access Authorization token for the User. + */ + value?: string; +} + +/** + * Diagnostic details. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model DiagnosticUpdateContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Diagnostic entity contract properties. + */ + properties?: DiagnosticContractUpdateProperties; +} + +/** + * Diagnostic Entity Properties + */ +model DiagnosticContractUpdateProperties { + /** + * Specifies for what type of messages sampling settings should not apply. + */ + alwaysLog?: AlwaysLog; + + /** + * Resource Id of a target logger. + */ + loggerId?: string; + + /** + * Sampling settings for Diagnostic. + */ + sampling?: SamplingSettings; + + /** + * Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. + */ + frontend?: PipelineDiagnosticSettings; + + /** + * Diagnostic settings for incoming/outgoing HTTP messages to the Backend + */ + backend?: PipelineDiagnosticSettings; + + /** + * Log the ClientIP. Default is false. + */ + logClientIp?: boolean; + + /** + * Sets correlation protocol to use for Application Insights diagnostics. + */ + httpCorrelationProtocol?: HttpCorrelationProtocol; + + /** + * The verbosity level applied to traces emitted by trace policies. + */ + verbosity?: Verbosity; + + /** + * The format of the Operation Name for Application Insights telemetries. Default is Name. + */ + operationNameFormat?: OperationNameFormat; + + /** + * Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings. + */ + metrics?: boolean; +} + +/** + * Properties of an API Management workspaceLinks resource. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ApiManagementWorkspaceLinksProperties + extends WorkspaceLinksBaseProperties {} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model WorkspaceLinksBaseProperties { + /** + * The link to the API Management service workspace. + */ + workspaceId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ApiManagement/service/workspaces"; + } + ]>; + + /** + * The array of linked gateways. + */ + gateways?: WorkspaceLinksGateway[]; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model WorkspaceLinksGateway { + /** + * The link to the API Management gateway. + */ + id?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ApiManagement/gateways"; + } + ]>; +} + +/** + * Paged workspace list representation. + */ +model WorkspaceCollection { + /** + * Page values. + */ + @pageItems + value?: WorkspaceContract[]; + + /** + * Total record count number across all pages. + */ + count?: int64; + + /** + * Next page link if any. + */ + @nextLink + nextLink?: string; +} + +/** + * Workspace entity properties. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model WorkspaceContractProperties { + /** + * Name of the workspace. + */ + displayName: string; + + /** + * Description of the workspace. + */ + description?: string; +} + +/** + * Object used to create an API Revision or Version based on an existing API Revision + */ +model ApiRevisionInfoContract { + /** + * Resource identifier of API to be used to create the revision from. + */ + sourceApiId?: string; + + /** + * Version identifier for the new API Version. + */ + @maxLength(100) + apiVersionName?: string; + + /** + * Description of new API Revision. + */ + @maxLength(256) + apiRevisionDescription?: string; + + /** + * Version set details + */ + apiVersionSet?: ApiVersionSetContractDetails; +} + +/** + * The response of the list policy operation. + */ +model PolicyWithComplianceCollection { + /** + * Policy Contract value. + */ + value?: PolicyWithComplianceContract[]; + + /** + * Next page link if any. + */ + nextLink?: string; +} + +/** + * Policy Contract details. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PolicyWithComplianceContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Properties of the Policy. + */ + properties?: PolicyWithComplianceContractProperties; +} + +/** + * Policy contract Properties. + */ +model PolicyWithComplianceContractProperties { + /** + * Policy Identifier + */ + referencePolicyId?: string; + + /** + * Policy Restriction Compliance State + */ + complianceState?: PolicyComplianceState = PolicyComplianceState.Pending; +} + +/** + * Quota counter value details. + */ +model QuotaCounterValueContract { + /** + * Quota counter Value Properties. + */ + value?: QuotaCounterValueContractProperties; +} + +/** + * Long Running Git Resolver Results. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ResolverResultContract + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Properties of the Resolver Contract. + */ + properties?: ResolverResultContractProperties; +} + +/** + * Resolver Result. + */ +model ResolverResultContractProperties { + /** + * Resolver result identifier. + */ + id?: string; + + /** + * Status of an async resolver. + */ + status?: AsyncResolverStatus; + + /** + * Start time of an async resolver. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + started?: utcDateTime; + + /** + * Last update time of an async resolver. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + * + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + updated?: utcDateTime; + + /** + * Optional result info. + */ + resultInfo?: string; + + /** + * Error Body Contract + */ + error?: ErrorResponseBody; + + /** + * This property if only provided as part of the TenantConfiguration_Validate resolver. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy resolver. + */ + @visibility(Lifecycle.Read) + @OpenAPI.extension("x-ms-identifiers", #["objectKey"]) + actionLog?: ResolverResultLogItemContract[]; +} + +/** + * Log of the entity being created, updated or deleted. + */ +model ResolverResultLogItemContract { + /** + * The type of entity contract. + */ + objectType?: string; + + /** + * Action like create/update/delete. + */ + action?: string; + + /** + * Identifier of the entity being created/updated/deleted. + */ + objectKey?: string; +} + +/** + * Trace collected in gateway. + */ +model GatewayTraceContract { + ...Record; +} + +/** + * Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results. + */ +model OperationListResult { + /** + * List of operations supported by the resource provider. + */ + @OpenAPI.extension("x-ms-identifiers", #["name"]) + @pageItems + value?: Operation[]; + + /** + * URL to get the next set of operation list results if there are any. + */ + @nextLink + nextLink?: string; +} + +/** + * The response of the List API Management gateway operation. + */ +model ApiManagementGatewayListResult { + /** + * Result of the List API Management gateway operation. + */ + @pageItems + value: ApiManagementGatewayResource[]; + + /** + * Link to the next set of results. Not empty if Value contains incomplete list of API Management services. + */ + @nextLink + nextLink?: string; +} + +/** + * The response of the List API Management services operation. + */ +model ApiManagementServiceListResult { + /** + * Result of the List API Management services operation. + */ + @pageItems + value: ApiManagementServiceResource[]; + + /** + * Link to the next set of results. Not empty if Value contains incomplete list of API Management services. + */ + @nextLink + nextLink?: string; +} + +/** + * The response of the List API Management gateway operation. + */ +model ApiManagementGatewayConfigConnectionListResult { + /** + * Result of the List API Management gateway config connection operation. + */ + @pageItems + value: ApiManagementGatewayConfigConnectionResource[]; + + /** + * Link to the next set of results. Not empty if Value contains incomplete list of API Management services. + */ + @nextLink + nextLink?: string; +} + +/** + * The response of the List API Management WorkspaceLink operation. + */ +model ApiManagementWorkspaceLinksListResult { + /** + * Result of the List API Management WorkspaceLinks operation. + */ + @pageItems + value: ApiManagementWorkspaceLinksResource[]; + + /** + * Link to the next set of results. Not empty if Value contains incomplete list of API Management services. + */ + @nextLink + nextLink?: string; +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apigateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apigateway.json deleted file mode 100644 index 42612eec26e2..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apigateway.json +++ /dev/null @@ -1,836 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs to manage Azure API Management gateway deployments.", - "version": "2024-10-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.ApiManagement/gateways/{gatewayName}": { - "put": { - "tags": [ - "ApiGateway" - ], - "operationId": "ApiGateway_CreateOrUpdate", - "description": "Creates or updates an API Management gateway. This is long running operation and could take several minutes to complete.", - "x-ms-examples": { - "ApiManagementCreateStandardGateway": { - "$ref": "./examples/ApiManagementCreateStandardGateway.json" - }, - "ApiManagementCreateWorkspacePremiumGateway": { - "$ref": "./examples/ApiManagementCreateWorkspacePremiumGateway.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementGatewayResource" - }, - "description": "Parameters supplied to the CreateOrUpdate API Management gateway operation." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The gateway was successfully set up.", - "schema": { - "$ref": "#/definitions/ApiManagementGatewayResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ApiManagementGatewayResource" - } - }, - "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 - }, - "patch": { - "tags": [ - "ApiGateway" - ], - "operationId": "ApiGateway_Update", - "description": "Updates an existing API Management gateway.", - "x-ms-examples": { - "ApiManagementUpdateStandardGateway": { - "$ref": "./examples/ApiManagementUpdateStandardGateway.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementGatewayUpdateParameters" - }, - "description": "Parameters supplied to the CreateOrUpdate API Management gateway operation." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The gateway was successfully updated.", - "schema": { - "$ref": "#/definitions/ApiManagementGatewayResource" - } - }, - "202": { - "description": "The gateway update request was Accepted.", - "headers": { - "location": { - "description": "Location 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 - }, - "get": { - "tags": [ - "ApiGateway" - ], - "operationId": "ApiGateway_Get", - "description": "Gets an API Management gateway resource description.", - "x-ms-examples": { - "ApiManagementGatewayGetGateway": { - "$ref": "./examples/ApiManagementGatewayGetGateway.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully got the API Management gateway Resource.", - "schema": { - "$ref": "#/definitions/ApiManagementGatewayResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiGateway" - ], - "operationId": "ApiGateway_Delete", - "description": "Deletes an existing API Management gateway.", - "x-ms-examples": { - "ApiManagementGatewayDeleteGateway": { - "$ref": "./examples/ApiManagementGatewayDeleteGateway.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "The gateway delete request was accepted.", - "schema": { - "$ref": "#/definitions/ApiManagementGatewayResource" - }, - "headers": { - "location": { - "description": "Location header", - "type": "string" - } - } - }, - "204": { - "description": "The gateway 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 - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways": { - "get": { - "tags": [ - "ApiGateway" - ], - "operationId": "ApiGateway_ListByResourceGroup", - "description": "List all API Management gateways within a resource group.", - "x-ms-examples": { - "ApiManagementListGatewaysBySubscriptionAndResourceGroup": { - "$ref": "./examples/ApiManagementListGatewaysBySubscriptionAndResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The API Management gateways list.", - "schema": { - "$ref": "#/definitions/ApiManagementGatewayListResult" - } - }, - "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.ApiManagement/gateways": { - "get": { - "tags": [ - "ApiGateway" - ], - "operationId": "ApiGateway_List", - "description": "List all API Management gateways within a subscription.", - "x-ms-examples": { - "ApiManagementListGatewaysBySubscription": { - "$ref": "./examples/ApiManagementListGatewaysBySubscription.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": "The API Management gateways list.", - "schema": { - "$ref": "#/definitions/ApiManagementGatewayListResult" - } - }, - "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.ApiManagement/gateways/{gatewayName}/skus": { - "get": { - "tags": [ - "ApiManagementGatewaySkus" - ], - "summary": "Gets available SKUs for API Management gateway", - "description": "Gets all available SKU for a given API Management gateway", - "operationId": "ApiManagementGatewaySkus_ListAvailableSkus", - "x-ms-examples": { - "ApiManagementListSKUs-Gateways": { - "$ref": "./examples/ApiManagementListSKUs-Gateways.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Success. The response describes the list of SKUs.", - "schema": { - "$ref": "#/definitions/GatewayResourceSkuResults" - } - }, - "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": { - "GatewaySku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the Sku.", - "externalDocs": { - "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" - }, - "enum": [ - "Standard", - "WorkspaceGatewayStandard", - "WorkspaceGatewayPremium" - ], - "x-ms-enum": { - "name": "ApiGatewaySkuType", - "modelAsString": true, - "values": [ - { - "value": "Standard", - "description": "Standard SKU of the API gateway." - }, - { - "value": "WorkspaceGatewayStandard", - "description": "Standard SKU of the API gateway to be used in Workspaces." - }, - { - "value": "WorkspaceGatewayPremium", - "description": "Premium SKU of the API gateway to be used in Workspaces." - } - ] - } - } - }, - "description": "Describes an available API Management SKU for gateways." - }, - "GatewayConfigurationApi": { - "type": "object", - "properties": { - "hostname": { - "readOnly": true, - "type": "string", - "description": "Hostname to which the agent connects to propagate configuration to the cloud." - } - }, - "description": "Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU." - }, - "FrontendConfiguration": { - "type": "object", - "properties": { - "defaultHostname": { - "readOnly": true, - "type": "string", - "description": "The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU." - } - }, - "description": "Information regarding how the gateway should be exposed." - }, - "BackendConfiguration": { - "type": "object", - "properties": { - "subnet": { - "$ref": "#/definitions/BackendSubnetConfiguration", - "description": "The default hostname of the data-plane gateway to which requests can be sent." - } - }, - "description": "Information regarding how the gateway should integrate with backend systems." - }, - "BackendSubnetConfiguration": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ARM ID of the subnet in which the backend systems are hosted." - } - }, - "description": "Information regarding how the subnet to which the gateway should be injected." - }, - "ApiManagementGatewayProperties": { - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "#/definitions/ApiManagementGatewayBaseProperties" - } - ], - "description": "Properties of an API Management gateway resource description." - }, - "ApiManagementGatewayUpdateProperties": { - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "#/definitions/ApiManagementGatewayBaseProperties" - } - ], - "description": "Properties of an API Management gateway resource description." - }, - "ApiManagementGatewayBaseProperties": { - "type": "object", - "properties": { - "provisioningState": { - "type": "string", - "description": "The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.", - "readOnly": true - }, - "targetProvisioningState": { - "type": "string", - "description": "The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.", - "readOnly": true - }, - "createdAtUtc": { - "type": "string", - "format": "date-time", - "description": "Creation UTC date of the API Management gateway.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.", - "readOnly": true - }, - "frontend": { - "$ref": "#/definitions/FrontendConfiguration", - "description": "Information regarding how the gateway should be exposed." - }, - "backend": { - "$ref": "#/definitions/BackendConfiguration", - "description": "Information regarding how the gateway should integrate with backend systems." - }, - "configurationApi": { - "$ref": "#/definitions/GatewayConfigurationApi", - "description": "Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU." - }, - "virtualNetworkType": { - "type": "string", - "description": "The type of VPN in which API Management gateway needs to be configured in. ", - "enum": [ - "None", - "External", - "Internal" - ], - "x-ms-enum": { - "name": "VirtualNetworkType", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "The API Management gateway is not part of any Virtual Network." - }, - { - "value": "External", - "description": "The API Management gateway is part of Virtual Network and it is accessible from Internet." - }, - { - "value": "Internal", - "description": "The API Management gateway is part of Virtual Network and it is only accessible from within the virtual network." - } - ] - } - } - }, - "description": "Base Properties of an API Management gateway resource description." - }, - "ApiManagementGatewayListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiManagementGatewayResource" - }, - "description": "Result of the List API Management gateway operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." - } - }, - "required": [ - "value" - ], - "description": "The response of the List API Management gateway operation." - }, - "ApiManagementGatewaySkuProperties": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the Sku.", - "externalDocs": { - "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" - }, - "enum": [ - "Standard", - "WorkspaceGatewayStandard", - "WorkspaceGatewayPremium" - ], - "x-ms-enum": { - "name": "ApiGatewaySkuType", - "modelAsString": true, - "values": [ - { - "value": "Standard", - "description": "Standard SKU of the API gateway." - }, - { - "value": "WorkspaceGatewayStandard", - "description": "Standard SKU of the API gateway to be used in Workspaces." - }, - { - "value": "WorkspaceGatewayPremium", - "description": "Premium SKU of the API gateway to be used in Workspaces." - } - ] - } - }, - "capacity": { - "type": "integer", - "format": "int32", - "description": "Capacity of the SKU (number of deployed units of the SKU)" - } - }, - "required": [ - "name" - ], - "description": "API Management gateway resource SKU properties." - }, - "ApiManagementGatewaySkuPropertiesForPatch": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the Sku.", - "externalDocs": { - "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" - }, - "enum": [ - "Standard", - "WorkspaceGatewayStandard", - "WorkspaceGatewayPremium" - ], - "x-ms-enum": { - "name": "ApiGatewaySkuType", - "modelAsString": true, - "values": [ - { - "value": "Standard", - "description": "Standard SKU of the API gateway." - }, - { - "value": "WorkspaceGatewayStandard", - "description": "Standard SKU of the API gateway to be used in Workspaces." - }, - { - "value": "WorkspaceGatewayPremium", - "description": "Premium SKU of the API gateway to be used in Workspaces." - } - ] - } - }, - "capacity": { - "type": "integer", - "format": "int32", - "description": "Capacity of the SKU (number of deployed units of the SKU)" - } - }, - "description": "API Management gateway resource SKU properties for PATCH operations given nothing should be required." - }, - "ApiManagementGatewayResource": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiManagementGatewayProperties", - "description": "Properties of the API Management gateway." - }, - "sku": { - "$ref": "#/definitions/ApiManagementGatewaySkuProperties", - "description": "SKU properties of the API Management gateway." - }, - "systemData": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", - "description": "Metadata pertaining to creation and last modification of the resource.", - "readOnly": true - }, - "location": { - "type": "string", - "description": "Resource location.", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "etag": { - "type": "string", - "description": "ETag of the resource.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/definitions/ApimResource" - } - ], - "required": [ - "location", - "sku", - "properties" - ], - "description": "A single API Management gateway resource in List or Get response." - }, - "ApimResource": { - "type": "object", - "description": "The Resource definition.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource ID." - }, - "name": { - "type": "string", - "description": "Resource name.", - "readOnly": true - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type for API Management resource is set to Microsoft.ApiManagement." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags." - } - }, - "x-ms-azure-resource": true - }, - "ApiManagementGatewayUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiManagementGatewayUpdateProperties", - "description": "Properties of the API Management gateway." - }, - "sku": { - "$ref": "#/definitions/ApiManagementGatewaySkuPropertiesForPatch", - "description": "SKU properties of the API Management gateway." - }, - "etag": { - "type": "string", - "description": "ETag of the resource.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/definitions/ApimResource" - } - ], - "description": "Parameter supplied to Update API Management gateway." - }, - "GatewayResourceSkuResults": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/GatewayResourceSkuResult" - }, - "x-ms-identifiers": [ - "resourceType", - "sku/name" - ], - "description": "The list of skus available for the gateway." - }, - "nextLink": { - "type": "string", - "description": "The uri to fetch the next page of API Management gateway Skus." - } - }, - "required": [ - "value" - ], - "description": "The API Management gateway SKUs operation response." - }, - "GatewayResourceSkuResult": { - "type": "object", - "properties": { - "resourceType": { - "readOnly": true, - "type": "string", - "description": "The type of resource the SKU applies to." - }, - "sku": { - "$ref": "#/definitions/GatewaySku", - "readOnly": true, - "description": "Specifies API Management gateway SKU." - }, - "capacity": { - "$ref": "#/definitions/GatewaySkuCapacity", - "readOnly": true, - "description": "Specifies the number of API Management gateway units." - } - }, - "description": "Describes an available API Management gateway SKU." - }, - "GatewaySkuCapacity": { - "type": "object", - "properties": { - "minimum": { - "type": "integer", - "readOnly": true, - "format": "int32", - "description": "The minimum capacity." - }, - "maximum": { - "type": "integer", - "readOnly": true, - "format": "int32", - "description": "The maximum capacity that can be set." - }, - "default": { - "type": "integer", - "readOnly": true, - "format": "int32", - "description": "The default capacity." - }, - "scaleType": { - "type": "string", - "readOnly": true, - "description": "The scale type applicable to the sku.", - "enum": [ - "Automatic", - "Manual", - "None" - ], - "x-ms-enum": { - "name": "GatewaySkuCapacityScaleType", - "modelAsString": true, - "values": [ - { - "value": "Automatic", - "description": "Supported scale type automatic." - }, - { - "value": "Manual", - "description": "Supported scale type manual." - }, - { - "value": "None", - "description": "Scaling not supported." - } - ] - } - } - }, - "description": "Describes scaling information of a SKU." - } - }, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimallpolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimallpolicies.json deleted file mode 100644 index 7418c411e57a..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimallpolicies.json +++ /dev/null @@ -1,85 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "REST API for getting policy status in an Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/allPolicies": { - "get": { - "tags": [ - "AllPolicies" - ], - "operationId": "AllPolicies_ListByService", - "description": "Status of all policies of API Management services.", - "x-ms-examples": { - "ApiManagementListPolicyRestrictions": { - "$ref": "./examples/ApiManagementAllPolicies.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Returns an array of Policy Status.", - "schema": { - "$ref": "./definitions.json#/definitions/AllPoliciesCollection" - } - }, - "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": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimanagement.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimanagement.json deleted file mode 100644 index c2ff235ca25e..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimanagement.json +++ /dev/null @@ -1,968 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.", - "version": "2024-10-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": {}, - "definitions": { - "ErrorFieldContract": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Property level error code." - }, - "message": { - "type": "string", - "description": "Human-readable representation of property-level error." - }, - "target": { - "type": "string", - "description": "Property name." - } - }, - "description": "Error Field contract." - }, - "ErrorResponseBody": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response." - }, - "message": { - "type": "string", - "description": "Human-readable representation of the error." - }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/ErrorFieldContract" - }, - "x-ms-identifiers": [ - "message", - "target" - ], - "description": "The list of invalid fields send in request, in case of validation error." - } - }, - "description": "Error Body contract." - }, - "RegionContract": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Region name.", - "readOnly": true - }, - "isMasterRegion": { - "description": "whether Region is the master region.", - "type": "boolean" - }, - "isDeleted": { - "description": "whether Region is deleted.", - "type": "boolean" - } - }, - "description": "Region profile." - }, - "RegionListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RegionContract" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "Lists of Regions." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Lists Regions operation response details." - } - }, - "parameters": { - "AccessParameter": { - "name": "accessName", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "access", - "gitAccess" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "AccessIdName" - }, - "description": "The identifier of the Access configuration.", - "x-ms-parameter-location": "method" - }, - "SettingsParameter": { - "name": "settingsType", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "public" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "settingsTypeName" - }, - "description": "The identifier of the settings.", - "x-ms-parameter-location": "method" - }, - "ApiIdParameter": { - "name": "apiId", - "in": "path", - "required": true, - "type": "string", - "description": "API identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "x-ms-parameter-location": "method" - }, - "ApiIdRevParameter": { - "name": "apiId", - "in": "path", - "required": true, - "type": "string", - "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "ApiVersionSetIdParameter": { - "name": "versionSetId", - "in": "path", - "required": true, - "type": "string", - "description": "Api Version Set identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "AppTypeParameter": { - "name": "appType", - "in": "query", - "required": false, - "type": "string", - "description": "Determines the type of application which send the create user request. Default is legacy publisher portal.", - "enum": [ - "portal", - "developerPortal" - ], - "x-ms-enum": { - "name": "AppType", - "modelAsString": true, - "values": [ - { - "value": "portal", - "description": "User create request was sent by legacy developer portal." - }, - { - "value": "developerPortal", - "description": "User create request was sent by new developer portal." - } - ] - }, - "default": "portal", - "x-ms-parameter-location": "method" - }, - "AttachmentIdParameter": { - "name": "attachmentId", - "in": "path", - "required": true, - "type": "string", - "description": "Attachment identifier within an Issue. Must be unique in the current Issue.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "AuthorizationProviderIdParameter": { - "name": "authorizationProviderId", - "in": "path", - "required": true, - "type": "string", - "description": "Identifier of the authorization provider.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "AuthorizationIdParameter": { - "name": "authorizationId", - "in": "path", - "required": true, - "type": "string", - "description": "Identifier of the authorization.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "AuthorizationAccessPolicyIdParameter": { - "name": "authorizationAccessPolicyId", - "in": "path", - "required": true, - "type": "string", - "description": "Identifier of the authorization access policy.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "AuthenticationServerIdParameter": { - "name": "authsid", - "in": "path", - "required": true, - "type": "string", - "description": "Identifier of the authorization server.", - "minLength": 1, - "maxLength": 80, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "BackendIdParameter": { - "name": "backendId", - "in": "path", - "required": true, - "type": "string", - "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "x-ms-parameter-location": "method" - }, - "CacheIdParameter": { - "name": "cacheId", - "in": "path", - "required": true, - "type": "string", - "description": "Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).", - "minLength": 1, - "maxLength": 80, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "CertificateIdParameter": { - "name": "certificateId", - "in": "path", - "required": true, - "type": "string", - "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "CommentIdParameter": { - "name": "commentId", - "in": "path", - "required": true, - "type": "string", - "description": "Comment identifier within an Issue. Must be unique in the current Issue.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "ConfigurationParameter": { - "name": "configurationName", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "configuration" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "configurationIdName" - }, - "description": "The identifier of the Git Configuration Operation.", - "x-ms-parameter-location": "method" - }, - "DiagnosticIdParameter": { - "name": "diagnosticId", - "in": "path", - "required": true, - "type": "string", - "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "EmailParameter": { - "name": "email", - "in": "path", - "required": true, - "type": "string", - "description": "Email identifier.", - "x-ms-parameter-location": "method" - }, - "GatewayNameParameter": { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the API Management gateway.", - "minLength": 1, - "maxLength": 45, - "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$", - "x-ms-parameter-location": "method" - }, - "ConfigConnectionNameParameter": { - "name": "configConnectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the API Management gateway config connection.", - "minLength": 1, - "maxLength": 30, - "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$", - "x-ms-parameter-location": "method" - }, - "GroupIdParameter": { - "name": "groupId", - "in": "path", - "required": true, - "type": "string", - "description": "Group identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 256, - "x-ms-parameter-location": "method" - }, - "IdentityProviderNameParameter": { - "name": "identityProviderName", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "facebook", - "google", - "microsoft", - "twitter", - "aad", - "aadB2C" - ], - "x-ms-enum": { - "name": "IdentityProviderType", - "modelAsString": true, - "values": [ - { - "value": "facebook", - "description": "Facebook as Identity provider." - }, - { - "value": "google", - "description": "Google as Identity provider." - }, - { - "value": "microsoft", - "description": "Microsoft Live as Identity provider." - }, - { - "value": "twitter", - "description": "Twitter as Identity provider." - }, - { - "value": "aad", - "description": "Azure Active Directory as Identity provider." - }, - { - "value": "aadB2C", - "description": "Azure Active Directory B2C as Identity provider." - } - ] - }, - "description": "Identity Provider Type identifier.", - "x-ms-parameter-location": "method" - }, - "IfMatchOptionalParameter": { - "name": "If-Match", - "in": "header", - "required": false, - "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", - "type": "string", - "x-ms-parameter-location": "method" - }, - "IfMatchRequiredParameter": { - "name": "If-Match", - "in": "header", - "required": true, - "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", - "type": "string", - "x-ms-parameter-location": "method" - }, - "IssueIdParameter": { - "name": "issueId", - "in": "path", - "required": true, - "type": "string", - "description": "Issue identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "LocationNameParameter": { - "name": "locationName", - "in": "path", - "required": true, - "type": "string", - "description": "Location in which the API Management service is deployed. This is one of the Azure Regions like West US, East US, South Central US.", - "minLength": 1, - "x-ms-parameter-location": "method" - }, - "LoggerIdParameter": { - "name": "loggerId", - "in": "path", - "required": true, - "type": "string", - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "description": "Logger identifier. Must be unique in the API Management service instance.", - "x-ms-parameter-location": "method" - }, - "NotificationNameParameter": { - "name": "notificationName", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "RequestPublisherNotificationMessage", - "PurchasePublisherNotificationMessage", - "NewApplicationNotificationMessage", - "BCC", - "NewIssuePublisherNotificationMessage", - "AccountClosedPublisher", - "QuotaLimitApproachingPublisherNotificationMessage" - ], - "x-ms-enum": { - "name": "NotificationName", - "modelAsString": true, - "values": [ - { - "value": "RequestPublisherNotificationMessage", - "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." - }, - { - "value": "PurchasePublisherNotificationMessage", - "description": "The following email recipients and users will receive email notifications about new API product subscriptions." - }, - { - "value": "NewApplicationNotificationMessage", - "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." - }, - { - "value": "BCC", - "description": "The following recipients will receive blind carbon copies of all emails sent to developers." - }, - { - "value": "NewIssuePublisherNotificationMessage", - "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." - }, - { - "value": "AccountClosedPublisher", - "description": "The following email recipients and users will receive email notifications when developer closes his account." - }, - { - "value": "QuotaLimitApproachingPublisherNotificationMessage", - "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." - } - ] - }, - "description": "Notification Name Identifier.", - "x-ms-parameter-location": "method" - }, - "NotifySubscriptionStateChangeParameter": { - "name": "notify", - "in": "query", - "required": false, - "type": "boolean", - "description": "Notify change in Subscription State. \n - If false, do not send any email notification for change of state of subscription \n - If true, send email notification of change of state of subscription ", - "x-ms-parameter-location": "method" - }, - "OpenIdConnectIdParameter": { - "name": "opid", - "in": "path", - "required": true, - "type": "string", - "description": "Identifier of the OpenID Connect Provider.", - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "OperationIdParameter": { - "name": "operationId", - "in": "path", - "required": true, - "type": "string", - "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "x-ms-parameter-location": "method" - }, - "ResolverIdParameter": { - "name": "resolverId", - "in": "path", - "required": true, - "type": "string", - "description": "Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "x-ms-parameter-location": "method" - }, - "PolicyExportFormat": { - "name": "format", - "in": "query", - "required": false, - "type": "string", - "description": "Policy Export Format.", - "enum": [ - "xml", - "rawxml" - ], - "x-ms-enum": { - "name": "PolicyExportFormat", - "modelAsString": true, - "values": [ - { - "value": "xml", - "description": "The contents are inline and Content type is an XML document." - }, - { - "value": "rawxml", - "description": "The contents are inline and Content type is a non XML encoded policy document." - } - ] - }, - "default": "xml", - "x-ms-parameter-location": "method" - }, - "PolicyIdParameter": { - "name": "policyId", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "policy" - ], - "description": "The identifier of the Policy.", - "x-ms-enum": { - "modelAsString": true, - "name": "PolicyIdName" - }, - "x-ms-parameter-location": "method" - }, - "IdParameter": { - "name": "id", - "in": "path", - "required": true, - "type": "string", - "description": "A resource identifier.", - "minLength": 1, - "maxLength": 80, - "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", - "x-ms-parameter-location": "method" - }, - "PolicyFragmentContentFormat": { - "name": "format", - "in": "query", - "required": false, - "type": "string", - "description": "Policy fragment content format.", - "enum": [ - "xml", - "rawxml" - ], - "x-ms-enum": { - "name": "PolicyFragmentContentFormat", - "modelAsString": true, - "values": [ - { - "value": "xml", - "description": "The contents are inline and Content type is an XML document." - }, - { - "value": "rawxml", - "description": "The contents are inline and Content type is a non XML encoded policy document." - } - ] - }, - "default": "xml", - "x-ms-parameter-location": "method" - }, - "PolicyRestrictionIdParameter": { - "name": "policyRestrictionId", - "in": "path", - "required": true, - "type": "string", - "description": "Policy restrictions after an entity level", - "minLength": 1, - "maxLength": 80, - "x-ms-parameter-location": "method" - }, - "PortalRevisionIdParameter": { - "name": "portalRevisionId", - "in": "path", - "required": true, - "type": "string", - "description": "Portal revision identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 256, - "x-ms-parameter-location": "method" - }, - "ProductIdParameter": { - "name": "productId", - "in": "path", - "required": true, - "type": "string", - "description": "Product identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 256, - "x-ms-parameter-location": "method" - }, - "ClientApplicationIdParameter": { - "name": "clientApplicationId", - "in": "path", - "required": true, - "type": "string", - "description": "Client Application identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 256, - "x-ms-parameter-location": "method" - }, - "ClientApplicationProductLinkIdParameter": { - "name": "clientApplicationProductLinkId", - "in": "path", - "required": true, - "type": "string", - "description": "Client Application Product Link identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 256, - "x-ms-parameter-location": "method" - }, - "NamedValueIdParameter": { - "name": "namedValueId", - "in": "path", - "required": true, - "type": "string", - "description": "Identifier of the NamedValue.", - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "QuotaCounterKeyParameter": { - "name": "quotaCounterKey", - "in": "path", - "required": true, - "type": "string", - "description": "Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key=\"boo\" in the policy, then it’s accessible by \"boo\" counter key. But if it’s defined as counter-key=\"@(\"b\"+\"a\")\" then it will be accessible by \"ba\" key", - "x-ms-parameter-location": "method" - }, - "QuotaPeriodKeyParameter": { - "name": "quotaPeriodKey", - "in": "path", - "required": true, - "type": "string", - "description": "Quota period key identifier.", - "x-ms-parameter-location": "method" - }, - "ReleaseIdParameter": { - "name": "releaseId", - "in": "path", - "required": true, - "type": "string", - "description": "Release identifier within an API. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "ServiceNameParameter": { - "name": "serviceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the API Management service.", - "minLength": 1, - "maxLength": 50, - "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$", - "x-ms-parameter-location": "method" - }, - "SkipQueryParameter": { - "name": "$skip", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Number of records to skip.", - "minimum": 0, - "x-ms-parameter-location": "method" - }, - "SubscriptionEntityIdParameter": { - "name": "sid", - "in": "path", - "required": true, - "type": "string", - "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "TagIdParameter": { - "name": "tagId", - "in": "path", - "required": true, - "type": "string", - "description": "Tag identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "TagDescriptionIdParameter": { - "name": "tagDescriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.", - "minLength": 1, - "maxLength": 80, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "TemplateNameParameter": { - "name": "templateName", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "applicationApprovedNotificationMessage", - "accountClosedDeveloper", - "quotaLimitApproachingDeveloperNotificationMessage", - "newDeveloperNotificationMessage", - "emailChangeIdentityDefault", - "inviteUserNotificationMessage", - "newCommentNotificationMessage", - "confirmSignUpIdentityDefault", - "newIssueNotificationMessage", - "purchaseDeveloperNotificationMessage", - "passwordResetIdentityDefault", - "passwordResetByAdminNotificationMessage", - "rejectDeveloperNotificationMessage", - "requestDeveloperNotificationMessage" - ], - "x-ms-enum": { - "name": "TemplateName", - "modelAsString": true - }, - "description": "Email Template Name Identifier.", - "x-ms-parameter-location": "method" - }, - "TopQueryParameter": { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Number of records to return.", - "minimum": 1, - "x-ms-parameter-location": "method" - }, - "UserIdParameter": { - "name": "userId", - "in": "path", - "required": true, - "type": "string", - "description": "User identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "x-ms-parameter-location": "method" - }, - "GatewayIdParameter": { - "name": "gatewayId", - "in": "path", - "required": true, - "type": "string", - "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", - "minLength": 1, - "maxLength": 80, - "x-ms-parameter-location": "method" - }, - "GatewayHostnameConfigurationIdParameter": { - "name": "hcId", - "in": "path", - "required": true, - "type": "string", - "description": "Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.", - "minLength": 1, - "maxLength": 80, - "x-ms-parameter-location": "method" - }, - "ContentTypeIdParameter": { - "name": "contentTypeId", - "in": "path", - "required": true, - "type": "string", - "description": "Content type identifier.", - "minLength": 1, - "maxLength": 80, - "x-ms-parameter-location": "method" - }, - "ContentItemIdParameter": { - "name": "contentItemId", - "in": "path", - "required": true, - "type": "string", - "description": "Content item identifier.", - "minLength": 1, - "maxLength": 80, - "x-ms-parameter-location": "method" - }, - "SchemaIdParameter": { - "name": "schemaId", - "in": "path", - "required": true, - "type": "string", - "description": "Schema id identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "x-ms-parameter-location": "method" - }, - "PortalConfigIdParameter": { - "name": "portalConfigId", - "in": "path", - "required": true, - "type": "string", - "description": "Portal configuration identifier.", - "minLength": 1, - "maxLength": 80, - "x-ms-parameter-location": "method" - }, - "DocumentationIdParameter": { - "name": "documentationId", - "in": "path", - "required": true, - "type": "string", - "description": "Documentation identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "WorkspaceIdParameter": { - "name": "workspaceId", - "in": "path", - "required": true, - "type": "string", - "description": "Workspace identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "ProductApiLinkIdParameter": { - "name": "apiLinkId", - "in": "path", - "required": true, - "type": "string", - "description": "Product-API link identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "ProductGroupLinkIdParameter": { - "name": "groupLinkId", - "in": "path", - "required": true, - "type": "string", - "description": "Product-Group link identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "TagApiLinkIdParameter": { - "name": "apiLinkId", - "in": "path", - "required": true, - "type": "string", - "description": "Tag-API link identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "TagOperationLinkIdParameter": { - "name": "operationLinkId", - "in": "path", - "required": true, - "type": "string", - "description": "Tag-operation link identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - }, - "TagProductLinkIdParameter": { - "name": "productLinkId", - "in": "path", - "required": true, - "type": "string", - "description": "Tag-product link identifier. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 80, - "pattern": "^[^*#&+:<>?]+$", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimapis.json deleted file mode 100644 index ef7926c8e5ce..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimapis.json +++ /dev/null @@ -1,5564 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on API entity and their Operations associated with your Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/apis": { - "get": { - "tags": [ - "Api" - ], - "operationId": "Api_ListByService", - "description": "Lists all APIs of the API Management service instance.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-apis" - }, - "x-ms-examples": { - "ApiManagementListApis": { - "$ref": "./examples/ApiManagementListApis.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq, ne | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "tags", - "in": "query", - "required": false, - "type": "string", - "description": "Include tags in the response." - }, - { - "name": "expandApiVersionSet", - "in": "query", - "required": false, - "type": "boolean", - "description": "Include full ApiVersionSet resource in response" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Paged Result response of Apis.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ApiContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}": { - "head": { - "tags": [ - "Api" - ], - "operationId": "Api_GetEntityTag", - "description": "Gets the entity state (Etag) version of the API specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApi": { - "$ref": "./examples/ApiManagementHeadApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified API entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Api" - ], - "operationId": "Api_Get", - "description": "Gets the details of the API specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetApiContract": { - "$ref": "./examples/ApiManagementGetApiContract.json" - }, - "ApiManagementGetApiRevisionContract": { - "$ref": "./examples/ApiManagementGetApiRevision.json" - } - }, - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified API entity.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Api" - ], - "operationId": "Api_CreateOrUpdate", - "description": "Creates new or updates existing specified API of the API Management service instance.", - "x-ms-examples": { - "ApiManagementCreateApiUsingOai3Import": { - "$ref": "./examples/ApiManagementCreateApiUsingOai3Import.json" - }, - "ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct": { - "$ref": "./examples/ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct.json" - }, - "ApiManagementCreateApiUsingSwaggerImport": { - "$ref": "./examples/ApiManagementCreateApiUsingSwaggerImport.json" - }, - "ApiManagementCreateApiUsingWadlImport": { - "$ref": "./examples/ApiManagementCreateApiUsingWadlImport.json" - }, - "ApiManagementCreateSoapToRestApiUsingWsdlImport": { - "$ref": "./examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json" - }, - "ApiManagementCreateSoapPassThroughApiUsingWsdlImport": { - "$ref": "./examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json" - }, - "ApiManagementCreateApi": { - "$ref": "./examples/ApiManagementCreateApi.json" - }, - "ApiManagementCreateApiWithMultipleAuthServers": { - "$ref": "./examples/ApiManagementCreateApiWithMultipleAuthServers.json" - }, - "ApiManagementCreateApiWithMultipleOpenIdConnectProviders": { - "$ref": "./examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json" - }, - "ApiManagementCreateWebSocketApi": { - "$ref": "./examples/ApiManagementCreateWebsocketApi.json" - }, - "ApiManagementCreateApiRevisionFromExistingApi": { - "$ref": "./examples/ApiManagementCreateApiRevisionFromExistingApi.json" - }, - "ApiManagementCreateApiNewVersionUsingExistingApi": { - "$ref": "./examples/ApiManagementCreateApiNewVersionUsingExistingApi.json" - }, - "ApiManagementCreateApiClone": { - "$ref": "./examples/ApiManagementCreateApiClone.json" - }, - "ApiManagementCreateApiWithOpenIdConnect": { - "$ref": "./examples/ApiManagementCreateApiWithOpenIdConnect.json" - }, - "ApiManagementCreateApiUsingImportOverrideServiceUrl": { - "$ref": "./examples/ApiManagementCreateApiUsingImportOverrideServiceUrl.json" - }, - "ApiManagementCreateGraphQLApi": { - "$ref": "./examples/ApiManagementCreateGraphQLApi.json" - }, - "ApiManagementCreateODataApi": { - "$ref": "./examples/ApiManagementCreateODataApi.json" - }, - "ApiManagementCreateGrpcApi": { - "$ref": "./examples/ApiManagementCreateGrpcApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ApiCreateOrUpdateParameter" - }, - "description": "Create or update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "API was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "200": { - "description": "API was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "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" - } - }, - "patch": { - "tags": [ - "Api" - ], - "operationId": "Api_Update", - "description": "Updates the specified API of the API Management service instance.", - "x-ms-examples": { - "ApiManagementUpdateApi": { - "$ref": "./examples/ApiManagementUpdateApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ApiUpdateContract" - }, - "description": "API Update Contract parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "API was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Api" - ], - "operationId": "Api_Delete", - "description": "Deletes the specified API of the API Management service instance.", - "x-ms-examples": { - "ApiManagementDeleteApi": { - "$ref": "./examples/ApiManagementDeleteApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "deleteRevisions", - "in": "query", - "required": false, - "type": "boolean", - "description": "Delete all revisions of the Api." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "The API was scheduled for deletion.", - "headers": { - "location": { - "description": "Location header", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "204": { - "description": "The API was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/revisions": { - "get": { - "tags": [ - "ApiRevision" - ], - "operationId": "ApiRevision_ListByService", - "description": "Lists all revisions of an API.", - "x-ms-examples": { - "ApiManagementListApiRevisions": { - "$ref": "./examples/ApiManagementListApiRevisions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a list of revision details.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiRevisionCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ApiRevisionContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases": { - "get": { - "tags": [ - "ApiRelease" - ], - "operationId": "ApiRelease_ListByService", - "description": "Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.", - "x-ms-examples": { - "ApiManagementListApiReleases": { - "$ref": "./examples/ApiManagementListApiReleases.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| notes | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a list of API Releases.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiReleaseCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ApiReleaseContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}": { - "head": { - "tags": [ - "ApiRelease" - ], - "operationId": "ApiRelease_GetEntityTag", - "description": "Returns the etag of an API release.", - "x-ms-examples": { - "ApiManagementHeadApiRelease": { - "$ref": "./examples/ApiManagementHeadApiRelease.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the entity state (Etag) version of the api release as specified by its identifier.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiRelease" - ], - "operationId": "ApiRelease_Get", - "description": "Returns the details of an API release.", - "x-ms-examples": { - "ApiManagementGetApiRelease": { - "$ref": "./examples/ApiManagementGetApiRelease.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns the details of an API Release.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiReleaseContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiRelease" - ], - "operationId": "ApiRelease_CreateOrUpdate", - "description": "Creates a new Release for the API.", - "x-ms-examples": { - "ApiManagementCreateApiRelease": { - "$ref": "./examples/ApiManagementCreateApiRelease.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ApiReleaseContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Release was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiReleaseContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Release was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiReleaseContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "ApiRelease" - ], - "operationId": "ApiRelease_Update", - "description": "Updates the details of the release of the API specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateApiRelease": { - "$ref": "./examples/ApiManagementUpdateApiRelease.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ApiReleaseContract" - }, - "description": "API Release Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Release was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiReleaseContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiRelease" - ], - "operationId": "ApiRelease_Delete", - "description": "Deletes the specified release in the API.", - "x-ms-examples": { - "ApiManagementDeleteApiRelease": { - "$ref": "./examples/ApiManagementDeleteApiRelease.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "API release successfully removed" - }, - "204": { - "description": "API release successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/operations": { - "get": { - "tags": [ - "ApiOperation" - ], - "operationId": "ApiOperation_ListByApi", - "description": "Lists a collection of the operations for the specified API.", - "x-ms-examples": { - "ApiManagementListApiOperations": { - "$ref": "./examples/ApiManagementListApiOperations.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "tags", - "in": "query", - "required": false, - "type": "string", - "description": "Include tags in the response." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A collection of operation summary entities at the API level.", - "schema": { - "$ref": "./definitions.json#/definitions/OperationCollection" - } - }, - "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-odata": "./definitions.json#/definitions/OperationContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}": { - "head": { - "tags": [ - "ApiOperation" - ], - "operationId": "ApiOperation_GetEntityTag", - "description": "Gets the entity state (Etag) version of the API operation specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiOperation": { - "$ref": "./examples/ApiManagementHeadApiOperation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified API operation entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiOperation" - ], - "operationId": "ApiOperation_Get", - "description": "Gets the details of the API Operation specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetApiOperation": { - "$ref": "./examples/ApiManagementGetApiOperation.json" - }, - "ApiManagementGetApiOperationPetStore": { - "$ref": "./examples/ApiManagementGetApiOperationPetStore.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Operation entity.", - "schema": { - "$ref": "./definitions.json#/definitions/OperationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiOperation" - ], - "operationId": "ApiOperation_CreateOrUpdate", - "description": "Creates a new operation in the API or updates an existing one.", - "x-ms-examples": { - "ApiManagementCreateApiOperation": { - "$ref": "./examples/ApiManagementCreateApiOperation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/OperationContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Operation was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/OperationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Operation was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/OperationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "ApiOperation" - ], - "operationId": "ApiOperation_Update", - "description": "Updates the details of the operation in the API specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateApiOperation": { - "$ref": "./examples/ApiManagementUpdateApiOperation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/OperationUpdateContract" - }, - "description": "API Operation Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/OperationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiOperation" - ], - "operationId": "ApiOperation_Delete", - "description": "Deletes the specified operation in the API.", - "x-ms-examples": { - "ApiManagementDeleteApiOperation": { - "$ref": "./examples/ApiManagementDeleteApiOperation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "API operation successfully removed" - }, - "204": { - "description": "API operation successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies": { - "get": { - "tags": [ - "ApiOperationPolicy" - ], - "operationId": "ApiOperationPolicy_ListByOperation", - "description": "Get the list of policy configuration at the API Operation level.", - "x-ms-examples": { - "ApiManagementListApiOperationPolicies": { - "$ref": "./examples/ApiManagementListApiOperationPolicies.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Api Operations Policy Collection.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyCollection" - } - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/{policyId}": { - "head": { - "tags": [ - "ApiOperationPolicy" - ], - "operationId": "ApiOperationPolicy_GetEntityTag", - "description": "Gets the entity state (Etag) version of the API operation policy specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiOperationPolicy": { - "$ref": "./examples/ApiManagementHeadApiOperationPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified API operation policy entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiOperationPolicy" - ], - "operationId": "ApiOperationPolicy_Get", - "description": "Get the policy configuration at the API Operation level.", - "x-ms-examples": { - "ApiManagementGetApiOperationPolicy": { - "$ref": "./examples/ApiManagementGetApiOperationPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Api Operation Policy information.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiOperationPolicy" - ], - "operationId": "ApiOperationPolicy_CreateOrUpdate", - "description": "Creates or updates policy configuration for the API Operation level.", - "x-ms-examples": { - "ApiManagementCreateApiOperationPolicy": { - "$ref": "./examples/ApiManagementCreateApiOperationPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "description": "The policy contents to apply." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Api Operation policy configuration was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Api Operation policy configuration of the tenant was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiOperationPolicy" - ], - "operationId": "ApiOperationPolicy_Delete", - "description": "Deletes the policy configuration at the Api Operation.", - "x-ms-examples": { - "ApiManagementDeleteApiOperationPolicy": { - "$ref": "./examples/ApiManagementDeleteApiOperationPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Policy successfully removed" - }, - "204": { - "description": "Policy successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags": { - "get": { - "tags": [ - "ApiOperationTag" - ], - "operationId": "Tag_ListByOperation", - "description": "Lists all Tags associated with the Operation.", - "x-ms-examples": { - "ApiManagementListApiOperationTags": { - "$ref": "./examples/ApiManagementListApiOperationTags.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a collection of tags associated with the Operation entity.", - "schema": { - "$ref": "./definitions.json#/definitions/TagCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}": { - "head": { - "tags": [ - "ApiOperationTag" - ], - "operationId": "Tag_GetEntityStateByOperation", - "description": "Gets the entity state version of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiOperationTag": { - "$ref": "./examples/ApiManagementHeadApiOperationTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Empty response body, ETag header entity state version.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiOperationTag" - ], - "operationId": "Tag_GetByOperation", - "description": "Get tag associated with the Operation.", - "x-ms-examples": { - "ApiManagementGetApiOperationTag": { - "$ref": "./examples/ApiManagementGetApiOperationTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the details of the tag specified by its identifier.", - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiOperationTag" - ], - "operationId": "Tag_AssignToOperation", - "description": "Assign tag to the Operation.", - "x-ms-examples": { - "ApiManagementCreateApiOperationTag": { - "$ref": "./examples/ApiManagementCreateApiOperationTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Tag was assigned to the Operation.", - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - } - }, - "200": { - "description": "Tag is already assigned to the Operation.", - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiOperationTag" - ], - "operationId": "Tag_DetachFromOperation", - "description": "Detach the tag from the Operation.", - "x-ms-examples": { - "ApiManagementDeleteApiOperationTag": { - "$ref": "./examples/ApiManagementDeleteApiOperationTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Tag was successfully removed from Operation" - }, - "204": { - "description": "Tag successfully removed by previous request or does not exist in Operation" - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers": { - "get": { - "tags": [ - "GraphQLApiResolver" - ], - "operationId": "GraphQLApiResolver_ListByApi", - "description": "Lists a collection of the resolvers for the specified GraphQL API.", - "x-ms-examples": { - "ApiManagementListGraphQLApiResolvers": { - "$ref": "./examples/ApiManagementListGraphQLApiResolvers.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A collection of resolvers summary entities at the GraphQL API level.", - "schema": { - "$ref": "./definitions.json#/definitions/ResolverCollection" - } - }, - "default": { - "description": "Error response describing why the resolver failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "./definitions.json#/definitions/ResolverContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}": { - "head": { - "tags": [ - "GraphQLApiResolver" - ], - "operationId": "GraphQLApiResolver_GetEntityTag", - "description": "Gets the entity state (Etag) version of the GraphQL API resolver specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadGraphQLApiResolver": { - "$ref": "./examples/ApiManagementHeadGraphQLApiResolver.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified GraphQL API resolver entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the resolver failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "GraphQLApiResolver" - ], - "operationId": "GraphQLApiResolver_Get", - "description": "Gets the details of the GraphQL API Resolver specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetGraphQLApiResolver": { - "$ref": "./examples/ApiManagementGetGraphQLApiResolver.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Resolver entity.", - "schema": { - "$ref": "./definitions.json#/definitions/ResolverContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the resolver failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "GraphQLApiResolver" - ], - "operationId": "GraphQLApiResolver_CreateOrUpdate", - "description": "Creates a new resolver in the GraphQL API or updates an existing one.", - "x-ms-examples": { - "ApiManagementCreateGraphQLApiResolver": { - "$ref": "./examples/ApiManagementCreateGraphQLApiResolver.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ResolverContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Resolver was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/ResolverContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Resolver was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ResolverContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the resolver failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "GraphQLApiResolver" - ], - "operationId": "GraphQLApiResolver_Update", - "description": "Updates the details of the resolver in the GraphQL API specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateGraphQLApiResolver": { - "$ref": "./examples/ApiManagementUpdateGraphQLApiResolver.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ResolverUpdateContract" - }, - "description": "GraphQL API Resolver Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Resolver was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ResolverContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the resolver failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "GraphQLApiResolver" - ], - "operationId": "GraphQLApiResolver_Delete", - "description": "Deletes the specified resolver in the GraphQL API.", - "x-ms-examples": { - "ApiManagementDeleteGraphQLApiResolver": { - "$ref": "./examples/ApiManagementDeleteGraphQLApiResolver.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "GraphQL API resolver successfully removed" - }, - "204": { - "description": "GraphQL API resolver successfully removed by previous request or does not exist" - }, - "default": { - "description": "Error response describing why the resolver failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}/policies": { - "get": { - "tags": [ - "GraphQLApiResolverPolicy" - ], - "operationId": "GraphQLApiResolverPolicy_ListByResolver", - "description": "Get the list of policy configuration at the GraphQL API Resolver level.", - "x-ms-examples": { - "ApiManagementListGraphQLApiResolverPolicies": { - "$ref": "./examples/ApiManagementListGraphQLApiResolverPolicies.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "GraphQL Api Resolvers Policy Collection.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyCollection" - } - }, - "default": { - "description": "Error response describing why the resolver failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}/policies/{policyId}": { - "head": { - "tags": [ - "GraphQLApiResolverPolicy" - ], - "operationId": "GraphQLApiResolverPolicy_GetEntityTag", - "description": "Gets the entity state (Etag) version of the GraphQL API resolver policy specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadGraphQLApiResolverPolicy": { - "$ref": "./examples/ApiManagementHeadGraphQLApiResolverPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified GraphQL API resolver policy entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the resolver failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "GraphQLApiResolverPolicy" - ], - "operationId": "GraphQLApiResolverPolicy_Get", - "description": "Get the policy configuration at the GraphQL API Resolver level.", - "x-ms-examples": { - "ApiManagementGetGraphQLApiResolverPolicy": { - "$ref": "./examples/ApiManagementGetGraphQLApiResolverPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "GraphQL Api Resolver Policy information.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the resolver failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "GraphQLApiResolverPolicy" - ], - "operationId": "GraphQLApiResolverPolicy_CreateOrUpdate", - "description": "Creates or updates policy configuration for the GraphQL API Resolver level.", - "x-ms-examples": { - "ApiManagementCreateGraphQLApiResolverPolicy": { - "$ref": "./examples/ApiManagementCreateGraphQLApiResolverPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "description": "The policy contents to apply." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "GraphQL Api Resolver policy configuration was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "GraphQL Api Resolver policy configuration of the tenant was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the resolver failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "GraphQLApiResolverPolicy" - ], - "operationId": "GraphQLApiResolverPolicy_Delete", - "description": "Deletes the policy configuration at the GraphQL Api Resolver.", - "x-ms-examples": { - "ApiManagementDeleteGraphQLApiResolverPolicy": { - "$ref": "./examples/ApiManagementDeleteGraphQLApiResolverPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ResolverIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Policy successfully removed" - }, - "204": { - "description": "Policy successfully removed by previous request or does not exist" - }, - "default": { - "description": "Error response describing why the resolver failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products": { - "get": { - "tags": [ - "ApiProduct" - ], - "operationId": "ApiProduct_ListByApis", - "description": "Lists all Products, which the API is part of.", - "x-ms-examples": { - "ApiManagementListApiProducts": { - "$ref": "./examples/ApiManagementListApiProducts.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a collection of products which have the Api entity.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ProductContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies": { - "get": { - "tags": [ - "ApiPolicy" - ], - "operationId": "ApiPolicy_ListByApi", - "description": "Get the policy configuration at the API level.", - "x-ms-examples": { - "ApiManagementListApiPolicies": { - "$ref": "./examples/ApiManagementListApiPolicies.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Apis Policy Collection.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyCollection" - } - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}": { - "head": { - "tags": [ - "ApiPolicy" - ], - "operationId": "ApiPolicy_GetEntityTag", - "description": "Gets the entity state (Etag) version of the API policy specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiPolicy": { - "$ref": "./examples/ApiManagementHeadApiPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified API Policy entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiPolicy" - ], - "operationId": "ApiPolicy_Get", - "description": "Get the policy configuration at the API level.", - "x-ms-examples": { - "ApiManagementGetApiPolicy": { - "$ref": "./examples/ApiManagementGetApiPolicy.json" - } - }, - "produces": [ - "application/json", - "application/vnd.ms-azure-apim.policy+xml", - "application/vnd.ms-azure-apim.policy.raw+xml" - ], - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Api Policy information.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiPolicy" - ], - "operationId": "ApiPolicy_CreateOrUpdate", - "description": "Creates or updates policy configuration for the API.", - "x-ms-examples": { - "ApiManagementCreateApiPolicy": { - "$ref": "./examples/ApiManagementCreateApiPolicy.json" - }, - "ApiManagementCreateApiPolicyNonXmlEncoded": { - "$ref": "./examples/ApiManagementCreateApiPolicyNonXmlEncoded.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "description": "The policy contents to apply." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Api policy configuration was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Api policy configuration of the tenant was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiPolicy" - ], - "operationId": "ApiPolicy_Delete", - "description": "Deletes the policy configuration at the Api.", - "x-ms-examples": { - "ApiManagementDeleteApiPolicy": { - "$ref": "./examples/ApiManagementDeleteApiPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the policy configuration at the API level." - }, - "204": { - "description": "Successfully deleted the policy configuration at the API level." - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/schemas": { - "get": { - "tags": [ - "ApiSchema" - ], - "operationId": "ApiSchema_ListByApi", - "description": "Get the schema configuration at the API level.", - "x-ms-examples": { - "ApiManagementListApiSchemas": { - "$ref": "./examples/ApiManagementListApiSchemas.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Apis Schema Collection.", - "schema": { - "$ref": "./definitions.json#/definitions/SchemaCollection" - } - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}": { - "head": { - "tags": [ - "ApiSchema" - ], - "operationId": "ApiSchema_GetEntityTag", - "description": "Gets the entity state (Etag) version of the schema specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiSchema": { - "$ref": "./examples/ApiManagementHeadApiSchema.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified schema entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiSchema" - ], - "operationId": "ApiSchema_Get", - "description": "Get the schema configuration at the API level.", - "x-ms-examples": { - "ApiManagementGetApiSchema": { - "$ref": "./examples/ApiManagementGetApiSchema.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Api Schema information.", - "schema": { - "$ref": "./definitions.json#/definitions/SchemaContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiSchema" - ], - "operationId": "ApiSchema_CreateOrUpdate", - "description": "Creates or updates schema configuration for the API.", - "x-ms-examples": { - "ApiManagementCreateApiSchema": { - "$ref": "./examples/ApiManagementCreateApiSchema.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/SchemaContract" - }, - "description": "The schema contents to apply." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Api schema configuration was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/SchemaContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "200": { - "description": "Api schema configuration of the tenant was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/SchemaContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "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" - } - }, - "delete": { - "tags": [ - "ApiSchema" - ], - "operationId": "ApiSchema_Delete", - "description": "Deletes the schema configuration at the Api.", - "x-ms-examples": { - "ApiManagementDeleteApiSchema": { - "$ref": "./examples/ApiManagementDeleteApiSchema.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "name": "force", - "in": "query", - "required": false, - "type": "boolean", - "description": "If true removes all references to the schema before deleting it." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the schema configuration at the API level." - }, - "204": { - "description": "Successfully deleted the schema configuration at the API level." - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics": { - "get": { - "tags": [ - "ApiDiagnostic" - ], - "operationId": "ApiDiagnostic_ListByService", - "description": "Lists all diagnostics of an API.", - "x-ms-examples": { - "ApiManagementListApiDiagnostics": { - "$ref": "./examples/ApiManagementListApiDiagnostics.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Paged Result response of diagnostics for an API.", - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticCollection" - } - }, - "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-odata": "./definitions.json#/definitions/DiagnosticContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}": { - "head": { - "tags": [ - "ApiDiagnostic" - ], - "operationId": "ApiDiagnostic_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiDiagnostic": { - "$ref": "./examples/ApiManagementHeadApiDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiDiagnostic" - ], - "operationId": "ApiDiagnostic_Get", - "description": "Gets the details of the Diagnostic for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetApiDiagnostic": { - "$ref": "./examples/ApiManagementGetApiDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Diagnostic entity.", - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiDiagnostic" - ], - "operationId": "ApiDiagnostic_CreateOrUpdate", - "description": "Creates a new Diagnostic for an API or updates an existing one.", - "x-ms-examples": { - "ApiManagementCreateApiDiagnostic": { - "$ref": "./examples/ApiManagementCreateApiDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Diagnostic was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Diagnostic was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "ApiDiagnostic" - ], - "operationId": "ApiDiagnostic_Update", - "description": "Updates the details of the Diagnostic for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateApiDiagnostic": { - "$ref": "./examples/ApiManagementUpdateApiDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "description": "Diagnostic Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Diagnostic was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiDiagnostic" - ], - "operationId": "ApiDiagnostic_Delete", - "description": "Deletes the specified Diagnostic from an API.", - "x-ms-examples": { - "ApiManagementDeleteApiDiagnostic": { - "$ref": "./examples/ApiManagementDeleteApiDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Diagnostic successfully removed" - }, - "204": { - "description": "Diagnostic successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/issues": { - "get": { - "tags": [ - "ApiIssue" - ], - "operationId": "ApiIssue_ListByService", - "description": "Lists all issues associated with the specified API.", - "x-ms-examples": { - "ApiManagementListApiIssues": { - "$ref": "./examples/ApiManagementListApiIssues.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
" - }, - { - "name": "expandCommentsAttachments", - "in": "query", - "required": false, - "type": "boolean", - "description": "Expand the comment attachments. " - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Paged Result response of issues for the API.", - "schema": { - "$ref": "./definitions.json#/definitions/IssueCollection" - } - }, - "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-odata": "./definitions.json#/definitions/IssueContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}": { - "head": { - "tags": [ - "ApiIssue" - ], - "operationId": "ApiIssue_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Issue for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiIssue": { - "$ref": "./examples/ApiManagementHeadApiIssue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiIssue" - ], - "operationId": "ApiIssue_Get", - "description": "Gets the details of the Issue for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetApiIssue": { - "$ref": "./examples/ApiManagementGetApiIssue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "name": "expandCommentsAttachments", - "in": "query", - "required": false, - "type": "boolean", - "description": "Expand the comment attachments. " - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Issue entity.", - "schema": { - "$ref": "./definitions.json#/definitions/IssueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiIssue" - ], - "operationId": "ApiIssue_CreateOrUpdate", - "description": "Creates a new Issue for an API or updates an existing one.", - "x-ms-examples": { - "ApiManagementCreateApiIssue": { - "$ref": "./examples/ApiManagementCreateApiIssue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/IssueContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "New api issue successfully added", - "schema": { - "$ref": "./definitions.json#/definitions/IssueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Api issue successfully updated", - "schema": { - "$ref": "./definitions.json#/definitions/IssueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "ApiIssue" - ], - "operationId": "ApiIssue_Update", - "description": "Updates an existing issue for an API.", - "x-ms-examples": { - "ApiManagementUpdateApiIssue": { - "$ref": "./examples/ApiManagementUpdateApiIssue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/IssueUpdateContract" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Api issue updated successfully.", - "schema": { - "$ref": "./definitions.json#/definitions/IssueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiIssue" - ], - "operationId": "ApiIssue_Delete", - "description": "Deletes the specified Issue from an API.", - "x-ms-examples": { - "ApiManagementDeleteApiIssue": { - "$ref": "./examples/ApiManagementDeleteApiIssue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Issue successfully removed" - }, - "204": { - "description": "Issue successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments": { - "get": { - "tags": [ - "ApiIssueComment" - ], - "operationId": "ApiIssueComment_ListByService", - "description": "Lists all comments for the Issue associated with the specified API.", - "x-ms-examples": { - "ApiManagementListApiIssueComments": { - "$ref": "./examples/ApiManagementListApiIssueComments.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Paged Result response of issue comments for the API.", - "schema": { - "$ref": "./definitions.json#/definitions/IssueCommentCollection" - } - }, - "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-odata": "./definitions.json#/definitions/IssueCommentContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}": { - "head": { - "tags": [ - "ApiIssueComment" - ], - "operationId": "ApiIssueComment_GetEntityTag", - "description": "Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiIssueComment": { - "$ref": "./examples/ApiManagementHeadApiIssueComment.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CommentIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiIssueComment" - ], - "operationId": "ApiIssueComment_Get", - "description": "Gets the details of the issue Comment for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetApiIssueComment": { - "$ref": "./examples/ApiManagementGetApiIssueComment.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CommentIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified issue Comment entity.", - "schema": { - "$ref": "./definitions.json#/definitions/IssueCommentContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiIssueComment" - ], - "operationId": "ApiIssueComment_CreateOrUpdate", - "description": "Creates a new Comment for the Issue in an API or updates an existing one.", - "x-ms-examples": { - "ApiManagementCreateApiIssueComment": { - "$ref": "./examples/ApiManagementCreateApiIssueComment.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CommentIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/IssueCommentContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "New api issue comment successfully added", - "schema": { - "$ref": "./definitions.json#/definitions/IssueCommentContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Api issue comment successfully updated", - "schema": { - "$ref": "./definitions.json#/definitions/IssueCommentContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiIssueComment" - ], - "operationId": "ApiIssueComment_Delete", - "description": "Deletes the specified comment from an Issue.", - "x-ms-examples": { - "ApiManagementDeleteApiIssueComment": { - "$ref": "./examples/ApiManagementDeleteApiIssueComment.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CommentIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Comment successfully removed" - }, - "204": { - "description": "Comment successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments": { - "get": { - "tags": [ - "ApiIssueAttachment" - ], - "operationId": "ApiIssueAttachment_ListByService", - "description": "Lists all attachments for the Issue associated with the specified API.", - "x-ms-examples": { - "ApiManagementListApiIssueAttachments": { - "$ref": "./examples/ApiManagementListApiIssueAttachments.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Paged Result response of issue attachments for the API.", - "schema": { - "$ref": "./definitions.json#/definitions/IssueAttachmentCollection" - } - }, - "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-odata": "./definitions.json#/definitions/IssueAttachmentContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments/{attachmentId}": { - "head": { - "tags": [ - "ApiIssueAttachment" - ], - "operationId": "ApiIssueAttachment_GetEntityTag", - "description": "Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiIssueAttachment": { - "$ref": "./examples/ApiManagementHeadApiIssueAttachment.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AttachmentIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiIssueAttachment" - ], - "operationId": "ApiIssueAttachment_Get", - "description": "Gets the details of the issue Attachment for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetApiIssueAttachment": { - "$ref": "./examples/ApiManagementGetApiIssueAttachment.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AttachmentIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified issue Attachment entity.", - "schema": { - "$ref": "./definitions.json#/definitions/IssueAttachmentContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiIssueAttachment" - ], - "operationId": "ApiIssueAttachment_CreateOrUpdate", - "description": "Creates a new Attachment for the Issue in an API or updates an existing one.", - "x-ms-examples": { - "ApiManagementCreateApiIssueAttachment": { - "$ref": "./examples/ApiManagementCreateApiIssueAttachment.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AttachmentIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/IssueAttachmentContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "New api issue attachment successfully added", - "schema": { - "$ref": "./definitions.json#/definitions/IssueAttachmentContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Api issue attachment successfully updated", - "schema": { - "$ref": "./definitions.json#/definitions/IssueAttachmentContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiIssueAttachment" - ], - "operationId": "ApiIssueAttachment_Delete", - "description": "Deletes the specified comment from an Issue.", - "x-ms-examples": { - "ApiManagementDeleteApiIssueAttachment": { - "$ref": "./examples/ApiManagementDeleteApiIssueAttachment.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AttachmentIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Attachment successfully removed" - }, - "204": { - "description": "Attachment successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions": { - "get": { - "tags": [ - "ApiTagDescription" - ], - "operationId": "ApiTagDescription_ListByService", - "description": "Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations", - "x-ms-examples": { - "ApiManagementListApiTagDescriptions": { - "$ref": "./examples/ApiManagementListApiTagDescriptions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a collection of tagDescriptions associated with the Api entity.", - "schema": { - "$ref": "./definitions.json#/definitions/TagDescriptionCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagDescriptionContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}": { - "head": { - "tags": [ - "ApiTagDescription" - ], - "operationId": "ApiTagDescription_GetEntityTag", - "description": "Gets the entity state version of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiTagDescription": { - "$ref": "./examples/ApiManagementHeadApiTagDescription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Empty response body, ETag header entity state version.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiTagDescription" - ], - "operationId": "ApiTagDescription_Get", - "description": "Get Tag description in scope of API", - "x-ms-examples": { - "ApiManagementGetApiTagDescription": { - "$ref": "./examples/ApiManagementGetApiTagDescription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the description of the tag specified by its identifier in scope if the Api.", - "schema": { - "$ref": "./definitions.json#/definitions/TagDescriptionContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiTagDescription" - ], - "operationId": "ApiTagDescription_CreateOrUpdate", - "description": "Create/Update tag description in scope of the Api.", - "x-ms-examples": { - "ApiManagementCreateApiTagDescription": { - "$ref": "./examples/ApiManagementCreateApiTagDescription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/TagDescriptionCreateParameters" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Tag Description was created for the Api.", - "schema": { - "$ref": "./definitions.json#/definitions/TagDescriptionContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Tag Description was updated for the Api.", - "schema": { - "$ref": "./definitions.json#/definitions/TagDescriptionContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiTagDescription" - ], - "operationId": "ApiTagDescription_Delete", - "description": "Delete tag description for the Api.", - "x-ms-examples": { - "ApiManagementDeleteApiTagDescription": { - "$ref": "./examples/ApiManagementDeleteApiTagDescription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Tag description successfully removed" - }, - "204": { - "description": "Tag description successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/tags": { - "get": { - "tags": [ - "ApiTag" - ], - "operationId": "Tag_ListByApi", - "description": "Lists all Tags associated with the API.", - "x-ms-examples": { - "ApiManagementListApiTags": { - "$ref": "./examples/ApiManagementListApiTags.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a collection of tags associated with the Api entity.", - "schema": { - "$ref": "./definitions.json#/definitions/TagCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}": { - "head": { - "tags": [ - "ApiTag" - ], - "operationId": "Tag_GetEntityStateByApi", - "description": "Gets the entity state version of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiTag": { - "$ref": "./examples/ApiManagementHeadApiTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Empty response body, ETag header entity state version.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiTag" - ], - "operationId": "Tag_GetByApi", - "description": "Get tag associated with the API.", - "x-ms-examples": { - "ApiManagementGetApiTag": { - "$ref": "./examples/ApiManagementGetApiTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the details of the tag specified by its identifier.", - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiTag" - ], - "operationId": "Tag_AssignToApi", - "description": "Assign tag to the Api.", - "x-ms-examples": { - "ApiManagementCreateApiTag": { - "$ref": "./examples/ApiManagementCreateApiTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Tag was assigned to the Api.", - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Tag is already assigned to the Api.", - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiTag" - ], - "operationId": "Tag_DetachFromApi", - "description": "Detach the tag from the Api.", - "x-ms-examples": { - "ApiManagementDeleteApiTag": { - "$ref": "./examples/ApiManagementDeleteApiTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "API/Tag association successfully removed" - }, - "204": { - "description": "API/Tag association successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags": { - "get": { - "tags": [ - "ApiOperationsByTag" - ], - "operationId": "Operation_ListByTags", - "description": "Lists a collection of operations associated with tags.", - "x-ms-examples": { - "ApiManagementListApiOperationsByTags": { - "$ref": "./examples/ApiManagementListApiOperationsByTags.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "includeNotTaggedOperations", - "in": "query", - "required": false, - "type": "boolean", - "description": "Include not tagged Operations." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of TagResource entities.", - "schema": { - "$ref": "./definitions.json#/definitions/TagResourceCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagResourceContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis/default": { - "head": { - "tags": [ - "ApiWiki" - ], - "operationId": "ApiWiki_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Wiki for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiWiki": { - "$ref": "./examples/ApiManagementHeadApiWiki.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiWiki" - ], - "operationId": "ApiWiki_Get", - "description": "Gets the details of the Wiki for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetApiWiki": { - "$ref": "./examples/ApiManagementGetApiWiki.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Wiki entity.", - "schema": { - "$ref": "./definitions.json#/definitions/WikiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiWiki" - ], - "operationId": "ApiWiki_CreateOrUpdate", - "description": "Creates a new Wiki for an API or updates an existing one.", - "x-ms-examples": { - "ApiManagementCreateApiWiki": { - "$ref": "./examples/ApiManagementCreateApiWiki.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/WikiContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Wiki was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/WikiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Wiki was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/WikiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "ApiWiki" - ], - "operationId": "ApiWiki_Update", - "description": "Updates the details of the Wiki for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateApiWiki": { - "$ref": "./examples/ApiManagementUpdateApiWiki.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/WikiUpdateContract" - }, - "description": "Wiki Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Wiki was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/WikiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiWiki" - ], - "operationId": "ApiWiki_Delete", - "description": "Deletes the specified Wiki from an API.", - "x-ms-examples": { - "ApiManagementDeleteApiWiki": { - "$ref": "./examples/ApiManagementDeleteApiWiki.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Wiki successfully removed" - }, - "204": { - "description": "Wiki successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/apis/{apiId}/wikis": { - "get": { - "tags": [ - "ApiWiki" - ], - "operationId": "ApiWikis_List", - "description": "Gets the wikis for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementListApiWikis": { - "$ref": "./examples/ApiManagementListApiWikis.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Wiki entity.", - "schema": { - "$ref": "./definitions.json#/definitions/WikiCollection" - } - }, - "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-odata": "./definitions.json#/definitions/WikiContract" - } - } - }, - "x-ms-paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?export=true": { - "get": { - "tags": [ - "Apis" - ], - "operationId": "ApiExport_Get", - "description": "Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.", - "x-ms-examples": { - "ApiManagementGetApiExportInOpenApi2dot0": { - "$ref": "./examples/ApiManagementGetApiExportInOpenApi2dot0.json" - }, - "ApiManagementGetApiExportInOpenApi3dot0": { - "$ref": "./examples/ApiManagementGetApiExportInOpenApi3dot0.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "format", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "swagger-link", - "wadl-link", - "wsdl-link", - "openapi-link", - "openapi+json-link" - ], - "x-ms-enum": { - "name": "ExportFormat", - "modelAsString": true, - "values": [ - { - "value": "swagger-link", - "description": "Export the Api Definition in OpenAPI 2.0 Specification as JSON document to the Storage Blob.", - "name": "Swagger" - }, - { - "value": "wsdl-link", - "description": "Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`", - "name": "Wsdl" - }, - { - "value": "wadl-link", - "description": "Export the Api Definition in WADL Schema to Storage Blob.", - "name": "Wadl" - }, - { - "value": "openapi-link", - "description": "Export the Api Definition in OpenAPI 3.0 Specification as YAML document to Storage Blob.", - "name": "Openapi" - }, - { - "value": "openapi+json-link", - "description": "Export the Api Definition in OpenAPI 3.0 Specification as JSON document to Storage Blob.", - "name": "OpenapiJson" - } - ] - }, - "description": "Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes. New formats can be added in the future." - }, - { - "name": "export", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "ExportApi" - }, - "description": "Query parameter required to export the API details." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response contains a stream with a full set of API metadata and includes API entity with an embedded array of operation entities.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiExportResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimapisByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimapisByTags.json deleted file mode 100644 index e53b9212bfcb..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimapisByTags.json +++ /dev/null @@ -1,106 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing retrieve a collection of Apis associated with a tag in Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/apisByTags": { - "get": { - "tags": [ - "ApisByTag" - ], - "operationId": "Api_ListByTags", - "description": "Lists a collection of apis associated with tags.", - "x-ms-examples": { - "ApiManagementListApisByTags": { - "$ref": "./examples/ApiManagementListApisByTags.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "includeNotTaggedApis", - "in": "query", - "required": false, - "type": "boolean", - "description": "Include not tagged APIs." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of TagResource entities.", - "schema": { - "$ref": "./definitions.json#/definitions/TagResourceCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagResourceContract" - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimapiversionsets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimapiversionsets.json deleted file mode 100644 index eba642065687..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimapiversionsets.json +++ /dev/null @@ -1,376 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on the ApiVersionSet entity associated with your Azure API Management deployment. Using this entity you create and manage API Version Sets that are used to group APIs for consistent versioning.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/apiVersionSets": { - "get": { - "tags": [ - "ApiVersionSet" - ], - "operationId": "ApiVersionSet_ListByService", - "description": "Lists a collection of API Version Sets in the specified service instance.", - "x-ms-examples": { - "ApiManagementListApiVersionSets": { - "$ref": "./examples/ApiManagementListApiVersionSets.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Api Version Set entities.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiVersionSetCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ApiVersionSetContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}": { - "head": { - "tags": [ - "ApiVersionSet" - ], - "operationId": "ApiVersionSet_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Api Version Set specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiVersionSet": { - "$ref": "./examples/ApiManagementHeadApiVersionSet.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified Api Version Set entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiVersionSet" - ], - "operationId": "ApiVersionSet_Get", - "description": "Gets the details of the Api Version Set specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetApiVersionSet": { - "$ref": "./examples/ApiManagementGetApiVersionSet.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the specified Api Version Set entity.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiVersionSetContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiVersionSet" - ], - "operationId": "ApiVersionSet_CreateOrUpdate", - "description": "Creates or Updates a Api Version Set.", - "x-ms-examples": { - "ApiManagementCreateApiVersionSet": { - "$ref": "./examples/ApiManagementCreateApiVersionSet.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ApiVersionSetContract" - }, - "description": "Create or update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Api Version Set was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiVersionSetContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Api Version Set was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiVersionSetContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "ApiVersionSet" - ], - "operationId": "ApiVersionSet_Update", - "description": "Updates the details of the Api VersionSet specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateApiVersionSet": { - "$ref": "./examples/ApiManagementUpdateApiVersionSet.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ApiVersionSetUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Api Version Set was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiVersionSetContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiVersionSets" - ], - "operationId": "ApiVersionSet_Delete", - "description": "Deletes specific Api Version Set.", - "x-ms-examples": { - "ApiManagementDeleteApiVersionSet": { - "$ref": "./examples/ApiManagementDeleteApiVersionSet.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The ApiVersion Set details were successfully deleted." - }, - "204": { - "description": "The ApiVersion Set details were successfully deleted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimauthorizationproviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimauthorizationproviders.json deleted file mode 100644 index c6940b57f414..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimauthorizationproviders.json +++ /dev/null @@ -1,901 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for managing Authorization Providers in your Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/authorizationProviders": { - "get": { - "tags": [ - "AuthorizationProvider" - ], - "operationId": "AuthorizationProvider_ListByService", - "description": "Lists a collection of authorization providers defined within a service instance.", - "x-ms-examples": { - "ApiManagementListAuthorizationProviders": { - "$ref": "./examples/ApiManagementListAuthorizationProviders.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A Collection of the Authorization Provider entities for the specified API Management service instance.", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationProviderCollection" - } - }, - "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-odata": "./definitions.json#/definitions/AuthorizationProviderContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}": { - "get": { - "tags": [ - "AuthorizationProvider" - ], - "operationId": "AuthorizationProvider_Get", - "description": "Gets the details of the authorization provider specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetAuthorizationProvider": { - "$ref": "./examples/ApiManagementGetAuthorizationProvider.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified authorization provider entity. No secrets included", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationProviderContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "AuthorizationProvider" - ], - "operationId": "AuthorizationProvider_CreateOrUpdate", - "description": "Creates or updates authorization provider.", - "x-ms-examples": { - "ApiManagementCreateAuthorizationProviderAADAuthCode": { - "$ref": "./examples/ApiManagementCreateAuthorizationProviderAADAuthCode.json" - }, - "ApiManagementCreateAuthorizationProviderAADClientCred": { - "$ref": "./examples/ApiManagementCreateAuthorizationProviderAADClientCred.json" - }, - "ApiManagementCreateAuthorizationProviderGenericOAuth2": { - "$ref": "./examples/ApiManagementCreateAuthorizationProviderGenericOAuth2.json" - }, - "ApiManagementCreateAuthorizationProviderOOBGoogle": { - "$ref": "./examples/ApiManagementCreateAuthorizationProviderOOBGoogle.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationProviderContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Authorization provider was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationProviderContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "The existing Authorization provider was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationProviderContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "AuthorizationProvider" - ], - "operationId": "AuthorizationProvider_Delete", - "description": "Deletes specific authorization provider from the API Management service instance.", - "x-ms-examples": { - "ApiManagementDeleteAuthorizationProvider": { - "$ref": "./examples/ApiManagementDeleteAuthorizationProvider.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Authorization provider was successfully deleted." - }, - "204": { - "description": "The authorization server settings were successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations": { - "get": { - "tags": [ - "Authorizations" - ], - "operationId": "Authorization_ListByAuthorizationProvider", - "description": "Lists a collection of authorization providers defined within a authorization provider.", - "x-ms-examples": { - "ApiManagementListAuthorizationsAuthCode": { - "$ref": "./examples/ApiManagementListAuthorizationsAuthCode.json" - }, - "ApiManagementListAuthorizationsClientCred": { - "$ref": "./examples/ApiManagementListAuthorizationsClientCred.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A Collection of the Authorization entities for the specified Authorization provider.", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationCollection" - } - }, - "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-odata": "./definitions.json#/definitions/AuthorizationContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}": { - "get": { - "tags": [ - "Authorization" - ], - "operationId": "Authorization_Get", - "description": "Gets the details of the authorization specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetAuthorization": { - "$ref": "./examples/ApiManagementGetAuthorization.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified authorization entity. No secrets included", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Authorization" - ], - "operationId": "Authorization_CreateOrUpdate", - "description": "Creates or updates authorization.", - "x-ms-examples": { - "ApiManagementCreateAuthorizationAADAuthCode": { - "$ref": "./examples/ApiManagementCreateAuthorizationAADAuthCode.json" - }, - "ApiManagementCreateAuthorizationAADClientCred": { - "$ref": "./examples/ApiManagementCreateAuthorizationAADClientCred.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Authorization was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "The existing Authorization was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Authorization" - ], - "operationId": "Authorization_Delete", - "description": "Deletes specific Authorization from the Authorization provider.", - "x-ms-examples": { - "ApiManagementDeleteAuthorization": { - "$ref": "./examples/ApiManagementDeleteAuthorization.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Authorization was successfully deleted." - }, - "204": { - "description": "The authorization resource was not found." - }, - "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.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/getLoginLinks": { - "post": { - "tags": [ - "AuthorizationLoginLinks" - ], - "operationId": "AuthorizationLoginLinks_Post", - "description": "Gets authorization login links.", - "x-ms-examples": { - "ApiManagementGetAuthorizationLoginRequest": { - "$ref": "./examples/ApiManagementGetAuthorizationLoginRequest.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationLoginRequestContract" - }, - "description": "Create parameters." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified authorization login link.", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationLoginResponseContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "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.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/confirmConsentCode": { - "post": { - "tags": [ - "AuthorizationConfirmConsentCode" - ], - "operationId": "Authorization_ConfirmConsentCode", - "description": "Confirm valid consent code to suppress Authorizations anti-phishing page.", - "x-ms-examples": { - "ApiManagementPostAuthorizationConfirmConsentCodeRequest": { - "$ref": "./examples/ApiManagementPostAuthorizationConfirmConsentCodeRequest.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationConfirmConsentCodeRequestContract" - }, - "description": "Create parameters." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body is empty.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "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.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/accessPolicies": { - "get": { - "tags": [ - "AuthorizationAccessPolicy" - ], - "operationId": "AuthorizationAccessPolicy_ListByAuthorization", - "description": "Lists a collection of authorization access policy defined within a authorization.", - "x-ms-examples": { - "ApiManagementListAuthorizationAccessPolicies": { - "$ref": "./examples/ApiManagementListAuthorizationAccessPolicies.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A Collection of the Authorization Access Policy entities for the specified Authorization provider.", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationAccessPolicyCollection" - } - }, - "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-odata": "./definitions.json#/definitions/AuthorizationAccessPolicyContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/accessPolicies/{authorizationAccessPolicyId}": { - "get": { - "tags": [ - "AuthorizationAccessPolicy" - ], - "operationId": "AuthorizationAccessPolicy_Get", - "description": "Gets the details of the authorization access policy specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetAuthorizationAccessPolicy": { - "$ref": "./examples/ApiManagementGetAuthorizationAccessPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationAccessPolicyIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified authorization access policy entity.", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationAccessPolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "AuthorizationAccessPolicy" - ], - "operationId": "AuthorizationAccessPolicy_CreateOrUpdate", - "description": "Creates or updates Authorization Access Policy.", - "x-ms-examples": { - "ApiManagementCreateAuthorizationAccessPolicy": { - "$ref": "./examples/ApiManagementCreateAuthorizationAccessPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationAccessPolicyIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationAccessPolicyContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Authorization access policy was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationAccessPolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "The existing Authorization access policy was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationAccessPolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "AuthorizationAccessPolicy" - ], - "operationId": "AuthorizationAccessPolicy_Delete", - "description": "Deletes specific access policy from the Authorization.", - "x-ms-examples": { - "ApiManagementDeleteAuthorizationAccessPolicy": { - "$ref": "./examples/ApiManagementDeleteAuthorizationAccessPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationProviderIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthorizationAccessPolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Authorization access policy was successfully deleted." - }, - "204": { - "description": "The authorization server settings were successfully deleted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimauthorizationservers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimauthorizationservers.json deleted file mode 100644 index b407f0193066..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimauthorizationservers.json +++ /dev/null @@ -1,427 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for managing OAuth2 servers configuration in your Azure API Management deployment. OAuth 2.0 can be used to authorize developer accounts for Azure API Management. For more information refer to [How to OAuth2](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-oauth2).", - "version": "2024-10-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.ApiManagement/service/{serviceName}/authorizationServers": { - "get": { - "tags": [ - "AuthorizationServer" - ], - "operationId": "AuthorizationServer_ListByService", - "description": "Lists a collection of authorization servers defined within a service instance.", - "x-ms-examples": { - "ApiManagementListAuthorizationServers": { - "$ref": "./examples/ApiManagementListAuthorizationServers.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A Collection of the Authorization Server entities for the specified API Management service instance.", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationServerCollection" - } - }, - "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-odata": "./definitions.json#/definitions/AuthorizationServerContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}": { - "head": { - "tags": [ - "AuthorizationServer" - ], - "operationId": "AuthorizationServer_GetEntityTag", - "description": "Gets the entity state (Etag) version of the authorizationServer specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadAuthorizationServer": { - "$ref": "./examples/ApiManagementHeadAuthorizationServer.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified authorization server entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "AuthorizationServer" - ], - "operationId": "AuthorizationServer_Get", - "description": "Gets the details of the authorization server specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetAuthorizationServer": { - "$ref": "./examples/ApiManagementGetAuthorizationServer.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the details of the specified authorization server. No secrets included.", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationServerContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "AuthorizationServer" - ], - "operationId": "AuthorizationServer_CreateOrUpdate", - "description": "Creates new authorization server or updates an existing authorization server.", - "x-ms-examples": { - "ApiManagementCreateAuthorizationServer": { - "$ref": "./examples/ApiManagementCreateAuthorizationServer.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationServerContract" - }, - "description": "Create or update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Authorization server was successfully registered.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationServerContract" - } - }, - "200": { - "description": "Authorization server is already registered.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationServerContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "AuthorizationServer" - ], - "operationId": "AuthorizationServer_Update", - "description": "Updates the details of the authorization server specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateAuthorizationServer": { - "$ref": "./examples/ApiManagementUpdateAuthorizationServer.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationServerUpdateContract" - }, - "description": "OAuth2 Server settings Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The authorization server settings were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationServerContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "AuthorizationServer" - ], - "operationId": "AuthorizationServer_Delete", - "description": "Deletes specific authorization server instance.", - "x-ms-examples": { - "ApiManagementDeleteAuthorizationServer": { - "$ref": "./examples/ApiManagementDeleteAuthorizationServer.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The authorization server settings were successfully deleted." - }, - "204": { - "description": "The authorization server settings were successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/authorizationServers/{authsid}/listSecrets": { - "post": { - "tags": [ - "AuthorizationServer" - ], - "operationId": "AuthorizationServer_ListSecrets", - "description": "Gets the client secret details of the authorization server.", - "x-ms-examples": { - "ApiManagementAuthorizationServerListSecrets": { - "$ref": "./examples/ApiManagementAuthorizationServerListSecrets.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AuthenticationServerIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the secrets of the specified authorization server.", - "schema": { - "$ref": "./definitions.json#/definitions/AuthorizationServerSecretsContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimbackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimbackends.json deleted file mode 100644 index 6b6b54457d38..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimbackends.json +++ /dev/null @@ -1,439 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Backend entity in Azure API Management deployment. The Backend entity in API Management represents a backend service that is configured to skip certification chain validation when using a self-signed certificate to test mutual certificate authentication.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/backends": { - "get": { - "tags": [ - "Backend" - ], - "operationId": "Backend_ListByService", - "description": "Lists a collection of backends in the specified service instance.", - "x-ms-examples": { - "ApiManagementListBackends": { - "$ref": "./examples/ApiManagementListBackends.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Backend entities.", - "schema": { - "$ref": "./definitions.json#/definitions/BackendCollection" - } - }, - "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-odata": "./definitions.json#/definitions/BackendContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}": { - "head": { - "tags": [ - "Backend" - ], - "operationId": "Backend_GetEntityTag", - "description": "Gets the entity state (Etag) version of the backend specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadBackend": { - "$ref": "./examples/ApiManagementHeadBackend.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/BackendIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified backend entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Backend" - ], - "operationId": "Backend_Get", - "description": "Gets the details of the backend specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetBackend": { - "$ref": "./examples/ApiManagementGetBackend.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/BackendIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Backend entity.", - "schema": { - "$ref": "./definitions.json#/definitions/BackendContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Backend" - ], - "operationId": "Backend_CreateOrUpdate", - "description": "Creates or Updates a backend.", - "x-ms-examples": { - "ApiManagementCreateBackendServiceFabric": { - "$ref": "./examples/ApiManagementCreateBackendServiceFabric.json" - }, - "ApiManagementCreateBackendProxyBackend": { - "$ref": "./examples/ApiManagementCreateBackendProxyBackend.json" - }, - "ApiManagementCreateBackendWithSimpleLoadBalancer": { - "$ref": "./examples/ApiManagementCreateBackendWithSimpleLoadBalancer.json" - }, - "ApiManagementCreateBackendWithPriorityBasedLoadBalancer": { - "$ref": "./examples/ApiManagementCreateBackendWithPriorityBasedLoadBalancer.json" - }, - "ApiManagementCreateBackendWithWeightedLoadBalancer": { - "$ref": "./examples/ApiManagementCreateBackendWithWeightedLoadBalancer.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/BackendIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/BackendContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Backend was successfully created.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/BackendContract" - } - }, - "200": { - "description": "The existing backend was successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/BackendContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Backend" - ], - "operationId": "Backend_Update", - "description": "Updates an existing backend.", - "x-ms-examples": { - "ApiManagementUpdateBackend": { - "$ref": "./examples/ApiManagementUpdateBackend.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/BackendIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/BackendUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The existing backend was successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/BackendContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Backend" - ], - "operationId": "Backend_Delete", - "description": "Deletes the specified backend.", - "x-ms-examples": { - "ApiManagementDeleteBackend": { - "$ref": "./examples/ApiManagementDeleteBackend.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/BackendIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The backend was successfully deleted." - }, - "204": { - "description": "The backend was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/backends/{backendId}/reconnect": { - "post": { - "tags": [ - "BackendReconnect" - ], - "operationId": "Backend_Reconnect", - "description": "Notifies the API Management gateway to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.", - "x-ms-examples": { - "ApiManagementBackendReconnect": { - "$ref": "./examples/ApiManagementBackendReconnect.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/BackendIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": false, - "schema": { - "$ref": "./definitions.json#/definitions/BackendReconnectContract" - }, - "description": "Reconnect request parameters." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "Reconnect request accepted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimcaches.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimcaches.json deleted file mode 100644 index 537d8c99d4c2..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimcaches.json +++ /dev/null @@ -1,372 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Cache entity in your Azure API Management deployment. Azure API Management also allows for caching responses in an external Azure Cache for Redis. For more information refer to [External Redis Cache in ApiManagement](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-cache-external).", - "version": "2024-10-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.ApiManagement/service/{serviceName}/caches": { - "get": { - "tags": [ - "Cache" - ], - "operationId": "Cache_ListByService", - "description": "Lists a collection of all external Caches in the specified service instance.", - "x-ms-examples": { - "ApiManagementListCaches": { - "$ref": "./examples/ApiManagementListCaches.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Returns a collection of Cache entity.", - "schema": { - "$ref": "./definitions.json#/definitions/CacheCollection" - } - }, - "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.ApiManagement/service/{serviceName}/caches/{cacheId}": { - "head": { - "tags": [ - "Cache" - ], - "operationId": "Cache_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Cache specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadCache": { - "$ref": "./examples/ApiManagementHeadCache.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CacheIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified Cache entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Cache" - ], - "operationId": "Cache_Get", - "description": "Gets the details of the Cache specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetCache": { - "$ref": "./examples/ApiManagementGetCache.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CacheIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Cache entity.", - "schema": { - "$ref": "./definitions.json#/definitions/CacheContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Cache" - ], - "operationId": "Cache_CreateOrUpdate", - "description": "Creates or updates an External Cache to be used in Api Management instance.", - "externalDocs": { - "description": "Use an external cache in Azure API Management", - "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-cache-external" - }, - "x-ms-examples": { - "ApiManagementCreateCache": { - "$ref": "./examples/ApiManagementCreateCache.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CacheIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/CacheContract" - }, - "description": "Create or Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "The new Cache was successfully added.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/CacheContract" - } - }, - "200": { - "description": "The Cache details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/CacheContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Cache" - ], - "operationId": "Cache_Update", - "description": "Updates the details of the cache specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateCache": { - "$ref": "./examples/ApiManagementUpdateCache.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CacheIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/CacheUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The Cache details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/CacheContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Cache" - ], - "operationId": "Cache_Delete", - "description": "Deletes specific Cache.", - "x-ms-examples": { - "ApiManagementDeleteCache": { - "$ref": "./examples/ApiManagementDeleteCache.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CacheIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The Cache was successfully deleted." - }, - "204": { - "description": "The Cache was successfully deleted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimcertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimcertificates.json deleted file mode 100644 index 3f2238d9825c..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimcertificates.json +++ /dev/null @@ -1,387 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Certificate entity in your Azure API Management deployment. Certificates can be used to setup mutual authentication with your Backend in API Management. For more information refer to [How to secure backend using Mutual Auth Certificate](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-mutual-certificates).", - "version": "2024-10-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.ApiManagement/service/{serviceName}/certificates": { - "get": { - "tags": [ - "Certificate" - ], - "operationId": "Certificate_ListByService", - "description": "Lists a collection of all certificates in the specified service instance.", - "x-ms-examples": { - "ApiManagementListCertificates": { - "$ref": "./examples/ApiManagementListCertificates.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| expirationDate | filter | ge, le, eq, ne, gt, lt | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "isKeyVaultRefreshFailed", - "in": "query", - "required": false, - "type": "boolean", - "description": "When set to true, the response contains only certificates entities which failed refresh." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Returns a collection of Certificate entity.", - "schema": { - "$ref": "./definitions.json#/definitions/CertificateCollection" - } - }, - "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-odata": "./definitions.json#/definitions/CertificateContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}": { - "head": { - "tags": [ - "Certificate" - ], - "operationId": "Certificate_GetEntityTag", - "description": "Gets the entity state (Etag) version of the certificate specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadCertificate": { - "$ref": "./examples/ApiManagementHeadCertificate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified certificate entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Certificate" - ], - "operationId": "Certificate_Get", - "description": "Gets the details of the certificate specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetCertificate": { - "$ref": "./examples/ApiManagementGetCertificate.json" - }, - "ApiManagementGetCertificateWithKeyVault": { - "$ref": "./examples/ApiManagementGetCertificateWithKeyVault.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Certificate entity.", - "schema": { - "$ref": "./definitions.json#/definitions/CertificateContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Certificate" - ], - "operationId": "Certificate_CreateOrUpdate", - "description": "Creates or updates the certificate being used for authentication with the backend.", - "externalDocs": { - "description": "How to secure back-end services using client certificate authentication in Azure API Management", - "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/" - }, - "x-ms-examples": { - "ApiManagementCreateCertificate": { - "$ref": "./examples/ApiManagementCreateCertificate.json" - }, - "ApiManagementCreateCertificateWithKeyVault": { - "$ref": "./examples/ApiManagementCreateCertificateWithKeyVault.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/CertificateCreateOrUpdateParameters" - }, - "description": "Create or Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "The new certificate was successfully added.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/CertificateContract" - } - }, - "200": { - "description": "The certificate details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/CertificateContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Certificate" - ], - "operationId": "Certificate_Delete", - "description": "Deletes specific certificate.", - "x-ms-examples": { - "ApiManagementDeleteCertificate": { - "$ref": "./examples/ApiManagementDeleteCertificate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The certificate was successfully deleted." - }, - "204": { - "description": "The certificate was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/certificates/{certificateId}/refreshSecret": { - "post": { - "tags": [ - "Certificate" - ], - "operationId": "Certificate_RefreshSecret", - "description": "From KeyVault, Refresh the certificate being used for authentication with the backend.", - "externalDocs": { - "description": "How to secure back-end services using client certificate authentication in Azure API Management", - "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/" - }, - "x-ms-examples": { - "ApiManagementRefreshCertificate": { - "$ref": "./examples/ApiManagementRefreshCertificate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The certificate details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/CertificateContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimclientApplications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimclientApplications.json deleted file mode 100644 index 8f258fc6e686..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimclientApplications.json +++ /dev/null @@ -1,570 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on ClientApplication entity associated with your Azure API Management deployment. The ClientApplication entity represents a client application that can be used to access APIs in the API Management service. The ClientApplication entity is used to manage the client application settings and other properties.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/clientApplications": { - "get": { - "tags": [ - "ClientApplication" - ], - "operationId": "ClientApplication_ListByService", - "description": "Lists a collection of client applications in the specified service instance.", - "x-ms-examples": { - "ApiManagementListProducts": { - "$ref": "./examples/ApiManagementListClientApplications.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
state | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A Collection of the ClientApplication entities for the specified API Management service instance.", - "schema": { - "$ref": "./definitions.json#/definitions/ClientApplicationCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ClientApplicationContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/clientApplications/{clientApplicationId}": { - "head": { - "tags": [ - "ClientApplication" - ], - "operationId": "ClientApplication_GetEntityTag", - "description": "Gets the entity state (Etag) version of the product specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadProduct": { - "$ref": "./examples/ApiManagementHeadClientApplication.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ClientApplicationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified Product entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ClientApplication" - ], - "operationId": "ClientApplication_Get", - "description": "Gets the details of the client application specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetClientApplication": { - "$ref": "./examples/ApiManagementGetClientApplication.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ClientApplicationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Client Application entity.", - "schema": { - "$ref": "./definitions.json#/definitions/ClientApplicationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ClientApplication" - ], - "operationId": "ClientApplication_CreateOrUpdate", - "description": "Creates or Updates a client application.", - "x-ms-examples": { - "ApiManagementCreateProduct": { - "$ref": "./examples/ApiManagementCreateClientApplication.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ClientApplicationIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ClientApplicationContract" - }, - "description": "Create or update parameters." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Client Application was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/ClientApplicationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Client Application was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ClientApplicationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ClientApplication" - ], - "operationId": "ClientApplication_Delete", - "description": "Delete client application.", - "x-ms-examples": { - "ApiManagementDeleteProduct": { - "$ref": "./examples/ApiManagementDeleteClientApplication.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ClientApplicationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Product was successfully removed." - }, - "204": { - "description": "Product was successfully removed by previous request or does not exist." - }, - "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.ApiManagement/service/{serviceName}/clientApplications/{clientApplicationId}/listSecrets": { - "post": { - "tags": [ - "ClientApplicationSecrets" - ], - "operationId": "ClientApplication_ListSecrets", - "description": "Retrived client application secrets.", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ClientApplicationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "x-ms-examples": { - "ApiManagementListProducts": { - "$ref": "./examples/ApiManagementListClientApplicationSecrets.json" - } - }, - "responses": { - "200": { - "description": "Client Application Secrets details.", - "schema": { - "$ref": "./definitions.json#/definitions/ClientApplicationSecretsContract" - } - }, - "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.ApiManagement/service/{serviceName}/clientApplications/{clientApplicationId}/productLinks": { - "get": { - "tags": [ - "ClientApplicationProductLink" - ], - "operationId": "ClientApplicationProductLink_ListByClientApplications", - "description": "Lists a collection of product links associated with the specified client application.", - "x-ms-examples": { - "ApiManagementListProducts": { - "$ref": "./examples/ApiManagementListClientApplicationProductLinks.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ClientApplicationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A Collection of product links associated with the specified client application.", - "schema": { - "$ref": "./definitions.json#/definitions/ClientApplicationProductLinkCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ClientApplicationContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/clientApplications/{clientApplicationId}/productLinks/{clientApplicationProductLinkId}": { - "get": { - "tags": [ - "ClientApplicationProductLink" - ], - "operationId": "ClientApplicationProductLink_Get", - "description": "Gets the product link for the client application.", - "x-ms-examples": { - "ApiManagementGetProductApiLink": { - "$ref": "./examples/ApiManagementGetClientApplicationProductLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ClientApplicationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ClientApplicationProductLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Product link entity.", - "schema": { - "$ref": "./definitions.json#/definitions/ClientApplicationProductLinkContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ClientApplicationProductLink" - ], - "operationId": "ClientApplicationProductLink_Create", - "description": "Adds an Product to the specified Client Application via link.", - "x-ms-examples": { - "ApiManagementCreateClientApplicationProductLink": { - "$ref": "./examples/ApiManagementCreateClientApplicationProductLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ClientApplicationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ClientApplicationProductLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ClientApplicationProductLinkContract" - }, - "description": "Create parameters." - } - ], - "responses": { - "200": { - "description": "The specified Product is already added to the client application.", - "schema": { - "$ref": "./definitions.json#/definitions/ClientApplicationProductLinkContract" - } - }, - "201": { - "description": "The product was successfully added to the client application.", - "schema": { - "$ref": "./definitions.json#/definitions/ClientApplicationProductLinkContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ClientApplicationProductLink" - ], - "operationId": "ClientApplicationProductLink_Delete", - "description": "Deletes the specified Product from the specified client application.", - "x-ms-examples": { - "ApiManagementDeleteClientApplicationProductLink": { - "$ref": "./examples/ApiManagementDeleteClientApplicationProductLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ClientApplicationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ClientApplicationProductLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Product link was successfully removed from client application" - }, - "204": { - "description": "Product link successfully removed by previous request or does not exist in client application" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimconnectivitycheck.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimconnectivitycheck.json deleted file mode 100644 index fc669ce70b17..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimconnectivitycheck.json +++ /dev/null @@ -1,104 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use this REST APIs to perform connectivity troubleshoot operations in API Management deployments.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/connectivityCheck": { - "post": { - "tags": [ - "PerformConnectivityCheck" - ], - "operationId": "PerformConnectivityCheckAsync", - "description": "Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.", - "x-ms-examples": { - "TCP Connectivity Check": { - "$ref": "./examples/ApiManagementPerformConnectivityCheck.json" - }, - "HTTP Connectivity Check": { - "$ref": "./examples/ApiManagementPerformConnectivityCheckHttpConnect.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "connectivityCheckRequestParams", - "description": "Connectivity Check request parameters.", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ConnectivityCheckRequest" - } - } - ], - "responses": { - "202": { - "description": "Request was accepted and is currently running. Location header contains the URL where the status of the long running operation can be checked and the result eventually retrieved.", - "headers": { - "location": { - "type": "string" - } - } - }, - "200": { - "description": "Connectivity Check Request was completed.", - "schema": { - "$ref": "./definitions.json#/definitions/ConnectivityCheckResponse" - } - }, - "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" - } - } - } - } -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimcontenttypes.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimcontenttypes.json deleted file mode 100644 index 8a5ea52c9eff..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimcontenttypes.json +++ /dev/null @@ -1,531 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations in Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/contentTypes": { - "get": { - "tags": [ - "ContentType" - ], - "operationId": "ContentType_ListByService", - "description": "Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.", - "x-ms-examples": { - "ApiManagementListContentTypes": { - "$ref": "./examples/ApiManagementListContentTypes.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Returns a collection of the Content Type entities.", - "schema": { - "$ref": "./definitions.json#/definitions/ContentTypeCollection" - } - }, - "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.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}": { - "get": { - "tags": [ - "ContentType" - ], - "operationId": "ContentType_Get", - "description": "Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.", - "x-ms-examples": { - "ApiManagementGetContentType": { - "$ref": "./examples/ApiManagementGetContentType.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Returns the details of the specified content type.", - "schema": { - "$ref": "./definitions.json#/definitions/ContentTypeContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ContentType" - ], - "operationId": "ContentType_CreateOrUpdate", - "description": "Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the `c-` prefix. Built-in content types can't be modified.", - "x-ms-examples": { - "ApiManagementCreateContentType": { - "$ref": "./examples/ApiManagementCreateContentType.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ContentTypeContract" - }, - "description": "Create or update parameters." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "The content type was successfully created.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/ContentTypeContract" - } - }, - "200": { - "description": "The existing content type was successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/ContentTypeContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ContentType" - ], - "operationId": "ContentType_Delete", - "description": "Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the `c-` prefix) can't be removed.", - "x-ms-examples": { - "ApiManagementDeleteContentType": { - "$ref": "./examples/ApiManagementDeleteContentType.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The content type was successfully deleted." - }, - "204": { - "description": "The content type was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems": { - "get": { - "tags": [ - "ContentTypeContentItem" - ], - "operationId": "ContentItem_ListByService", - "description": "Lists developer portal's content items specified by the provided content type.", - "x-ms-examples": { - "ApiManagementListContentTypeContentItems": { - "$ref": "./examples/ApiManagementListContentTypeContentItems.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Returns a collection of Content Type entities.", - "schema": { - "$ref": "./definitions.json#/definitions/ContentItemCollection" - } - }, - "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.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}": { - "head": { - "tags": [ - "ContentTypeContentItem" - ], - "operationId": "ContentItem_GetEntityTag", - "description": "Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadContentTypeContentItem": { - "$ref": "./examples/ApiManagementHeadContentTypeContentItem.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ContentItemIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified content item entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ContentTypeContentItem" - ], - "operationId": "ContentItem_Get", - "description": "Returns the developer portal's content item specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetContentTypeContentItem": { - "$ref": "./examples/ApiManagementGetContentTypeContentItem.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ContentItemIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Returns the content item.", - "schema": { - "$ref": "./definitions.json#/definitions/ContentItemContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ContentTypeContentItem" - ], - "operationId": "ContentItem_CreateOrUpdate", - "description": "Creates a new developer portal's content item specified by the provided content type.", - "x-ms-examples": { - "ApiManagementCreateContentTypeContentItem": { - "$ref": "./examples/ApiManagementCreateContentTypeContentItem.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ContentItemIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ContentItemContract" - }, - "description": "Create or update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "The content item was successfully created.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/ContentItemContract" - } - }, - "200": { - "description": "The existing content item was successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/ContentItemContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ContentTypeContentItem" - ], - "operationId": "ContentItem_Delete", - "description": "Removes the specified developer portal's content item.", - "x-ms-examples": { - "ApiManagementDeleteContentTypeContentItem": { - "$ref": "./examples/ApiManagementDeleteContentTypeContentItem.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ContentTypeIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ContentItemIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The content item was successfully deleted." - }, - "204": { - "description": "The content item was successfully deleted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimdeletedservices.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimdeletedservices.json deleted file mode 100644 index 2e6b506f243d..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimdeletedservices.json +++ /dev/null @@ -1,184 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations in Azure API Management deployment.", - "version": "2024-10-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}/providers/Microsoft.ApiManagement/deletedservices": { - "get": { - "tags": [ - "DeletedService" - ], - "operationId": "DeletedServices_ListBySubscription", - "description": "Lists all soft-deleted services available for undelete for the given subscription.", - "x-ms-examples": { - "ApiManagementDeletedServicesListBySubscription": { - "$ref": "./examples/ApiManagementDeletedServicesListBySubscription.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": "List of all soft-deleted services available for undelete for the given subscription.", - "schema": { - "$ref": "./definitions.json#/definitions/DeletedServicesCollection" - } - }, - "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.ApiManagement/locations/{location}/deletedservices/{serviceName}": { - "get": { - "tags": [ - "DeletedService" - ], - "operationId": "DeletedServices_GetByName", - "description": "Get soft-deleted Api Management Service by name.", - "x-ms-examples": { - "ApiManagementGetDeletedServiceByName": { - "$ref": "./examples/ApiManagementGetDeletedServiceByName.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location of the deleted API Management service." - } - ], - "responses": { - "200": { - "description": "Soft-deleted Api Management Service.", - "schema": { - "$ref": "./definitions.json#/definitions/DeletedServiceContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "DeletedService" - ], - "operationId": "DeletedServices_Purge", - "description": "Purges Api Management Service (deletes it with no option to undelete).", - "x-ms-examples": { - "ApiManagementDeletedServicesPurge": { - "$ref": "./examples/ApiManagementDeletedServicesPurge.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location of the deleted API Management service." - } - ], - "responses": { - "200": { - "description": "Api Service was successfully purged." - }, - "202": { - "description": "Api Service purge started.", - "headers": { - "location": { - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/DeletedServiceContract" - } - }, - "204": { - "description": "The service 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" - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimdeployment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimdeployment.json deleted file mode 100644 index 78bf96d00568..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimdeployment.json +++ /dev/null @@ -1,2199 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs to manage Azure API Management deployment.", - "version": "2024-10-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": { - "/providers/Microsoft.ApiManagement/operations": { - "get": { - "tags": [ - "ApiManagementOperations" - ], - "description": "Lists all of the available REST API operations of the Microsoft.ApiManagement provider.", - "operationId": "ApiManagementOperations_List", - "x-ms-examples": { - "ApiManagementListOperations": { - "$ref": "./examples/ApiManagementListOperations.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success. The response describes the list of operations.", - "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-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/skus": { - "get": { - "tags": [ - "ApiManagementServiceSkus" - ], - "summary": "Gets available SKUs for API Management service", - "description": "Gets all available SKU for a given API Management service", - "operationId": "ApiManagementServiceSkus_ListAvailableServiceSkus", - "x-ms-examples": { - "ApiManagementListSKUs-Dedicated": { - "$ref": "./examples/ApiManagementListSKUs-Dedicated.json" - }, - "ApiManagementListSKUs-Consumption": { - "$ref": "./examples/ApiManagementListSKUs-Consumption.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Success. The response describes the list of SKUs.", - "schema": { - "$ref": "#/definitions/ResourceSkuResults" - } - }, - "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.ApiManagement/service/{serviceName}/restore": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementService_Restore", - "description": "Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete.", - "x-ms-examples": { - "ApiManagementRestoreService": { - "$ref": "./examples/ApiManagementRestoreWithAccessKey.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementServiceBackupRestoreParameters" - }, - "description": "Parameters supplied to the Restore API Management service from backup operation." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully restored the backup onto the API Management service.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked.", - "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.ApiManagement/service/{serviceName}/backup": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementService_Backup", - "description": "Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.", - "x-ms-examples": { - "ApiManagementBackupWithAccessKey": { - "$ref": "./examples/ApiManagementBackupWithAccessKey.json" - }, - "ApiManagementBackupWithSystemManagedIdentity": { - "$ref": "./examples/ApiManagementBackupWithSystemManagedIdentity.json" - }, - "ApiManagementBackupWithUserAssignedManagedIdentity": { - "$ref": "./examples/ApiManagementBackupWithUserAssignedManagedIdentity.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementServiceBackupRestoreParameters" - }, - "description": "Parameters supplied to the ApiManagementService_Backup operation." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully backed up the API Management service to the storage account.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked.", - "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.ApiManagement/service/{serviceName}": { - "put": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementService_CreateOrUpdate", - "description": "Creates or updates an API Management service. This is long running operation and could take several minutes to complete.", - "x-ms-examples": { - "ApiManagementCreateService": { - "$ref": "./examples/ApiManagementCreateService.json" - }, - "ApiManagementCreateServiceWithDeveloperPortal": { - "$ref": "./examples/ApiManagementCreateServiceWithDeveloperPortal.json" - }, - "ApiManagementCreateServiceInVnetWithPublicIP": { - "$ref": "./examples/ApiManagementCreateServiceInVnetWithPublicIP.json" - }, - "ApiManagementCreateMultiRegionServiceWithCustomHostname": { - "$ref": "./examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json" - }, - "ApiManagementCreateServiceHavingMsi": { - "$ref": "./examples/ApiManagementCreateServiceHavingMsi.json" - }, - "ApiManagementCreateServiceWithSystemCertificates": { - "$ref": "./examples/ApiManagementCreateServiceWithSystemCertificates.json" - }, - "ApiManagementCreateServiceWithUserAssignedIdentity": { - "$ref": "./examples/ApiManagementCreateServiceWithUserAssignedIdentity.json" - }, - "ApiManagementCreateServiceInZones": { - "$ref": "./examples/ApiManagementCreateServiceInZones.json" - }, - "ApiManagementCreateServiceSkuv2Service": { - "$ref": "./examples/ApiManagementCreateServiceSkuv2Service.json" - }, - "ApiManagementUndelete": { - "$ref": "./examples/ApiManagementUndelete.json" - }, - "ApiManagementCreateServiceWithCustomHostnameKeyVault": { - "$ref": "./examples/ApiManagementCreateServiceWithCustomHostnameKeyVault.json" - }, - "ApiManagementCreateServiceWithNatGatewayEnabled": { - "$ref": "./examples/ApiManagementCreateServiceWithNatGatewayEnabled.json" - }, - "ApiManagementCreateServiceWithoutLegacyConfigurationApi": { - "$ref": "./examples/ApiManagementCreateServiceWithoutLegacyConfigurationApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - }, - "description": "Parameters supplied to the CreateOrUpdate API Management service operation." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The service was successfully set up.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "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 - }, - "patch": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementService_Update", - "description": "Updates an existing API Management service.", - "x-ms-examples": { - "ApiManagementUpdateServiceDisableTls10": { - "$ref": "./examples/ApiManagementUpdateServiceDisableTls10.json" - }, - "ApiManagementUpdateServicePublisherDetails": { - "$ref": "./examples/ApiManagementUpdateServicePublisherDetails.json" - }, - "ApiManagementUpdateServiceToNewVnetAndAvailabilityZones": { - "$ref": "./examples/ApiManagementUpdateServiceToNewVnetAndAZs.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementServiceUpdateParameters" - }, - "description": "Parameters supplied to the CreateOrUpdate API Management service operation." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The service was successfully updated.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "202": { - "description": "The service update request was Accepted.", - "headers": { - "location": { - "description": "Location 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 - }, - "get": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementService_Get", - "description": "Gets an API Management service resource description.", - "x-ms-examples": { - "ApiManagementServiceGetService": { - "$ref": "./examples/ApiManagementServiceGetService.json" - }, - "ApiManagementServiceGetServiceHavingMsi": { - "$ref": "./examples/ApiManagementServiceGetServiceHavingMsi.json" - }, - "ApiManagementServiceGetMultiRegionInternalVnet": { - "$ref": "./examples/ApiManagementServiceGetMultiRegionInternalVnet.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully got the API Management Service Resource.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementService_Delete", - "description": "Deletes an existing API Management service.", - "x-ms-examples": { - "ApiManagementServiceDeleteService": { - "$ref": "./examples/ApiManagementServiceDeleteService.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Service was successfully deleted." - }, - "202": { - "description": "The service delete request was Accepted.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - }, - "headers": { - "location": { - "description": "Location header", - "type": "string" - } - } - }, - "204": { - "description": "The service 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 - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/migrateToStv2": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementService_MigrateToStv2", - "description": "Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. This is long running operation and could take several minutes to complete.", - "x-ms-examples": { - "ApiManagementMigrateService": { - "$ref": "./examples/ApiManagementServiceMigrateToStv2.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/MigrateToStv2Contract" - }, - "description": "Optional parameters supplied to migrate service." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The service was successfully migrated.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "202": { - "description": "Migration request submitted.", - "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.ApiManagement/service": { - "get": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementService_ListByResourceGroup", - "description": "List all API Management services within a resource group.", - "x-ms-examples": { - "ApiManagementListServiceBySubscriptionAndResourceGroup": { - "$ref": "./examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The API Management service list.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceListResult" - } - }, - "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.ApiManagement/service": { - "get": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementService_List", - "description": "Lists all API Management services within an Azure subscription.", - "x-ms-examples": { - "ApiManagementListServiceBySubscription": { - "$ref": "./examples/ApiManagementListServiceBySubscription.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": "The API Management service list.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceListResult" - } - }, - "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.ApiManagement/service/{serviceName}/getssotoken": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementService_GetSsoToken", - "description": "Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.", - "x-ms-examples": { - "ApiManagementServiceGetSsoToken": { - "$ref": "./examples/ApiManagementServiceGetSsoToken.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK if successful with the SSO Redirect URI.", - "schema": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiManagementServiceGetSsoTokenResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/checkNameAvailability": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementService_CheckNameAvailability", - "description": "Checks availability and correctness of a name for an API Management service.", - "x-ms-examples": { - "ApiManagementServiceCheckNameAvailability": { - "$ref": "./examples/ApiManagementServiceCheckNameAvailability.json" - } - }, - "parameters": [ - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementServiceCheckNameAvailabilityParameters" - }, - "description": "Parameters supplied to the CheckNameAvailability operation." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The result of check name availability.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceNameAvailabilityResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/getDomainOwnershipIdentifier": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementService_GetDomainOwnershipIdentifier", - "description": "Get the custom domain ownership identifier for an API Management service.", - "x-ms-examples": { - "ApiManagementServiceGetDomainOwnershipIdentifier": { - "$ref": "./examples/ApiManagementServiceGetDomainOwnershipIdentifier.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": "The result of getting domain ownership identifier.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceGetDomainOwnershipIdentifierResult" - } - }, - "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.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementService_ApplyNetworkConfigurationUpdates", - "description": "Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.", - "x-ms-examples": { - "ApiManagementApplyNetworkConfigurationUpdates": { - "$ref": "./examples/ApiManagementApplyNetworkConfigurationUpdates.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ApiManagementServiceApplyNetworkConfigurationParameters" - }, - "description": "Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Network configuration updates were successfully applied on the Api Management service.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked.", - "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": { - "ResourceSkuResults": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceSkuResult" - }, - "x-ms-identifiers": [ - "resourceType", - "sku/name" - ], - "description": "The list of skus available for the service." - }, - "nextLink": { - "type": "string", - "description": "The uri to fetch the next page of API Management service Skus." - } - }, - "required": [ - "value" - ], - "description": "The API Management service SKUs operation response." - }, - "ResourceSkuResult": { - "type": "object", - "properties": { - "resourceType": { - "readOnly": true, - "type": "string", - "description": "The type of resource the SKU applies to." - }, - "sku": { - "$ref": "#/definitions/ResourceSku", - "readOnly": true, - "description": "Specifies API Management SKU." - }, - "capacity": { - "$ref": "#/definitions/ResourceSkuCapacity", - "readOnly": true, - "description": "Specifies the number of API Management units." - } - }, - "description": "Describes an available API Management service SKU." - }, - "ResourceSkuCapacity": { - "type": "object", - "properties": { - "minimum": { - "type": "integer", - "readOnly": true, - "format": "int32", - "description": "The minimum capacity." - }, - "maximum": { - "type": "integer", - "readOnly": true, - "format": "int32", - "description": "The maximum capacity that can be set." - }, - "default": { - "type": "integer", - "readOnly": true, - "format": "int32", - "description": "The default capacity." - }, - "scaleType": { - "type": "string", - "readOnly": true, - "description": "The scale type applicable to the sku.", - "enum": [ - "automatic", - "manual", - "none" - ], - "x-ms-enum": { - "name": "ResourceSkuCapacityScaleType", - "modelAsString": true, - "values": [ - { - "value": "automatic", - "description": "Supported scale type automatic." - }, - { - "value": "manual", - "description": "Supported scale type manual." - }, - { - "value": "none", - "description": "Scaling not supported." - } - ] - } - } - }, - "description": "Describes scaling information of a SKU." - }, - "MigrateToStv2Contract": { - "type": "object", - "properties": { - "mode": { - "type": "string", - "description": "Mode of Migration to stv2. Default is PreserveIp.", - "externalDocs": { - "url": "https://aka.ms/apim-migrate-stv2" - }, - "enum": [ - "PreserveIp", - "NewIP" - ], - "x-ms-enum": { - "name": "MigrateToStv2Mode", - "modelAsString": true, - "values": [ - { - "value": "PreserveIp", - "description": "Migrate API Management service to stv2 from stv1, by reserving the IP Address of the service. This will have a downtime of upto 15 minutes, while the IP address is getting migrate to new infrastructure." - }, - { - "value": "NewIP", - "description": "Migrate API Management service to stv2 from stv1. This will have no downtime as the service configuration will be migrated to new infrastructure, but the IP address will changed." - } - ] - } - } - }, - "description": "Describes an available API Management SKU." - }, - "ResourceSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the Sku.", - "externalDocs": { - "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" - }, - "enum": [ - "Developer", - "Standard", - "Premium", - "Basic", - "Consumption", - "Isolated", - "BasicV2", - "StandardV2" - ], - "x-ms-enum": { - "name": "SkuType", - "modelAsString": true, - "values": [ - { - "value": "Developer", - "description": "Developer SKU of Api Management." - }, - { - "value": "Standard", - "description": "Standard SKU of Api Management." - }, - { - "value": "Premium", - "description": "Premium SKU of Api Management." - }, - { - "value": "Basic", - "description": "Basic SKU of Api Management." - }, - { - "value": "Consumption", - "description": "Consumption SKU of Api Management." - }, - { - "value": "Isolated", - "description": "Isolated SKU of Api Management." - }, - { - "value": "BasicV2", - "description": "BasicV2 SKU of Api Management." - }, - { - "value": "StandardV2", - "description": "StandardV2 SKU of Api Management." - } - ] - } - } - }, - "description": "Describes an available API Management SKU." - }, - "CertificateInformation": { - "type": "object", - "properties": { - "expiry": { - "type": "string", - "format": "date-time", - "description": "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." - }, - "thumbprint": { - "type": "string", - "description": "Thumbprint of the certificate." - }, - "subject": { - "type": "string", - "description": "Subject of the certificate." - } - }, - "required": [ - "expiry", - "thumbprint", - "subject" - ], - "description": "SSL certificate information." - }, - "CertificateConfiguration": { - "type": "object", - "properties": { - "encodedCertificate": { - "type": "string", - "description": "Base64 Encoded certificate." - }, - "certificatePassword": { - "type": "string", - "description": "Certificate Password." - }, - "storeName": { - "description": "The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.", - "type": "string", - "enum": [ - "CertificateAuthority", - "Root" - ] - }, - "certificate": { - "$ref": "#/definitions/CertificateInformation", - "description": "Certificate information." - } - }, - "required": [ - "storeName" - ], - "description": "Certificate configuration which consist of non-trusted intermediates and root certificates." - }, - "HostnameConfiguration": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Hostname type.", - "enum": [ - "Proxy", - "Portal", - "Management", - "Scm", - "DeveloperPortal", - "ConfigurationApi" - ], - "x-ms-enum": { - "name": "HostnameType", - "modelAsString": true - } - }, - "hostName": { - "type": "string", - "description": "Hostname to configure on the Api Management service." - }, - "keyVaultId": { - "type": "string", - "description": "Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type *application/x-pkcs12*" - }, - "identityClientId": { - "type": "string", - "description": "System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate." - }, - "encodedCertificate": { - "type": "string", - "description": "Base64 Encoded certificate." - }, - "certificatePassword": { - "type": "string", - "description": "Certificate Password." - }, - "defaultSslBinding": { - "type": "boolean", - "description": "Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.", - "default": false - }, - "negotiateClientCertificate": { - "type": "boolean", - "description": "Specify true to always negotiate client certificate on the hostname. Default Value is false.", - "default": false - }, - "certificate": { - "$ref": "#/definitions/CertificateInformation", - "description": "Certificate information." - }, - "certificateSource": { - "type": "string", - "description": "Certificate Source.", - "enum": [ - "Managed", - "KeyVault", - "Custom", - "BuiltIn" - ], - "x-ms-enum": { - "name": "CertificateSource", - "modelAsString": true - } - }, - "certificateStatus": { - "type": "string", - "description": "Certificate Status.", - "enum": [ - "Completed", - "Failed", - "InProgress" - ], - "x-ms-enum": { - "name": "CertificateStatus", - "modelAsString": true - } - } - }, - "required": [ - "type", - "hostName" - ], - "description": "Custom hostname configuration." - }, - "ConfigurationApi": { - "type": "object", - "properties": { - "legacyApi": { - "type": "string", - "default": "Enabled", - "description": "Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "LegacyApiState", - "modelAsString": true, - "values": [ - { - "value": "Enabled", - "description": "Legacy Configuration API (v1) is enabled for the service and self-hosted gateways can connect to it." - }, - { - "value": "Disabled", - "description": "Legacy Configuration API (v1) is disabled for the service and self-hosted gateways can not connect to it." - } - ] - } - } - }, - "description": "Information regarding the Configuration API of the API Management service." - }, - "VirtualNetworkConfiguration": { - "type": "object", - "properties": { - "vnetid": { - "readOnly": true, - "type": "string", - "description": "The virtual network ID. This is typically a GUID. Expect a null GUID by default." - }, - "subnetname": { - "readOnly": true, - "type": "string", - "description": "The name of the subnet." - }, - "subnetResourceId": { - "type": "string", - "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$", - "description": "The full resource ID of a subnet in a virtual network to deploy the API Management service in." - } - }, - "description": "Configuration of a virtual network to which API Management service is deployed." - }, - "AdditionalLocation": { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "The location name of the additional region among Azure Data center regions." - }, - "sku": { - "$ref": "#/definitions/ApiManagementServiceSkuProperties", - "description": "SKU properties of the API Management service." - }, - "zones": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of availability zones denoting where the resource needs to come from." - }, - "publicIPAddresses": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU." - }, - "privateIPAddresses": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU." - }, - "publicIpAddressId": { - "type": "string", - "description": "Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network." - }, - "virtualNetworkConfiguration": { - "$ref": "#/definitions/VirtualNetworkConfiguration", - "description": "Virtual network configuration for the location." - }, - "gatewayRegionalUrl": { - "type": "string", - "description": "Gateway URL of the API Management service in the Region.", - "readOnly": true - }, - "natGatewayState": { - "type": "string", - "description": "Property can be used to enable NAT Gateway for this API Management service.", - "default": "Disabled", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "NatGatewayState", - "modelAsString": true, - "values": [ - { - "value": "Enabled", - "description": "Nat Gateway is enabled for the service." - }, - { - "value": "Disabled", - "description": "Nat Gateway is disabled for the service." - } - ] - } - }, - "outboundPublicIPAddresses": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform." - }, - "disableGateway": { - "type": "boolean", - "description": "Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.", - "default": false - }, - "platformVersion": { - "type": "string", - "description": "Compute Platform Version running the service.", - "readOnly": true, - "enum": [ - "undetermined", - "stv1", - "stv2", - "mtv1", - "stv2.1" - ], - "x-ms-enum": { - "name": "PlatformVersion", - "modelAsString": true, - "values": [ - { - "value": "undetermined", - "description": "Platform version cannot be determined, as compute platform is not deployed." - }, - { - "value": "stv1", - "description": "Platform running the service on Single Tenant V1 platform." - }, - { - "value": "stv2", - "description": "Platform running the service on Single Tenant V2 platform." - }, - { - "value": "mtv1", - "description": "Platform running the service on Multi Tenant V1 platform." - }, - { - "value": "stv2.1", - "description": "Platform running the service on Single Tenant V2 platform on newer Hardware." - } - ] - } - } - }, - "required": [ - "location", - "sku" - ], - "description": "Description of an additional API Management resource location." - }, - "ApiManagementServiceBackupRestoreParameters": { - "type": "object", - "properties": { - "storageAccount": { - "type": "string", - "description": "The name of the Azure storage account (used to place/retrieve the backup)." - }, - "containerName": { - "type": "string", - "description": "The name of the blob container (used to place/retrieve the backup)." - }, - "backupName": { - "type": "string", - "description": "The name of the backup file to create/retrieve." - }, - "accessType": { - "type": "string", - "description": "The type of access to be used for the storage account.", - "default": "AccessKey", - "enum": [ - "AccessKey", - "SystemAssignedManagedIdentity", - "UserAssignedManagedIdentity" - ], - "x-ms-enum": { - "name": "AccessType", - "modelAsString": true, - "values": [ - { - "value": "AccessKey", - "description": "Use access key." - }, - { - "value": "SystemAssignedManagedIdentity", - "description": "Use system assigned managed identity." - }, - { - "value": "UserAssignedManagedIdentity", - "description": "Use user assigned managed identity." - } - ] - } - }, - "accessKey": { - "type": "string", - "description": "Storage account access key. Required only if `accessType` is set to `AccessKey`." - }, - "clientId": { - "type": "string", - "description": "The Client ID of user assigned managed identity. Required only if `accessType` is set to `UserAssignedManagedIdentity`." - } - }, - "required": [ - "storageAccount", - "containerName", - "backupName" - ], - "description": "Parameters supplied to the Backup/Restore of an API Management service operation." - }, - "ApiManagementServiceProperties": { - "type": "object", - "properties": { - "publisherEmail": { - "type": "string", - "description": "Publisher email.", - "maxLength": 100 - }, - "publisherName": { - "type": "string", - "description": "Publisher name.", - "maxLength": 100 - } - }, - "allOf": [ - { - "$ref": "#/definitions/ApiManagementServiceBaseProperties" - } - ], - "required": [ - "publisherEmail", - "publisherName" - ], - "description": "Properties of an API Management service resource description." - }, - "ApiManagementServiceUpdateProperties": { - "type": "object", - "properties": { - "publisherEmail": { - "type": "string", - "description": "Publisher email.", - "maxLength": 100 - }, - "publisherName": { - "type": "string", - "description": "Publisher name.", - "maxLength": 100 - } - }, - "allOf": [ - { - "$ref": "#/definitions/ApiManagementServiceBaseProperties" - } - ], - "description": "Properties of an API Management service resource description." - }, - "ApiManagementServiceBaseProperties": { - "type": "object", - "properties": { - "notificationSenderEmail": { - "type": "string", - "description": "Email address from which the notification will be sent.", - "maxLength": 100 - }, - "provisioningState": { - "type": "string", - "description": "The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.", - "readOnly": true - }, - "targetProvisioningState": { - "type": "string", - "description": "The provisioning state of the API Management service, which is targeted by the long running operation started on the service.", - "readOnly": true - }, - "createdAtUtc": { - "type": "string", - "format": "date-time", - "description": "Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.", - "readOnly": true - }, - "gatewayUrl": { - "type": "string", - "description": "Gateway URL of the API Management service.", - "readOnly": true - }, - "gatewayRegionalUrl": { - "type": "string", - "description": "Gateway URL of the API Management service in the Default Region.", - "readOnly": true - }, - "portalUrl": { - "type": "string", - "description": "Publisher portal endpoint Url of the API Management service.", - "readOnly": true - }, - "managementApiUrl": { - "type": "string", - "description": "Management API endpoint URL of the API Management service.", - "readOnly": true - }, - "scmUrl": { - "type": "string", - "description": "SCM endpoint URL of the API Management service.", - "readOnly": true - }, - "developerPortalUrl": { - "type": "string", - "description": "DEveloper Portal endpoint URL of the API Management service.", - "readOnly": true - }, - "hostnameConfigurations": { - "type": "array", - "items": { - "$ref": "#/definitions/HostnameConfiguration" - }, - "x-ms-identifiers": [ - "hostName", - "type" - ], - "description": "Custom hostname configuration of the API Management service." - }, - "publicIPAddresses": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU." - }, - "privateIPAddresses": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU." - }, - "publicIpAddressId": { - "type": "string", - "description": "Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network." - }, - "publicNetworkAccess": { - "description": "Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "name": "PublicNetworkAccess", - "modelAsString": true - } - }, - "configurationApi": { - "$ref": "#/definitions/ConfigurationApi", - "description": "Configuration API configuration of the API Management service." - }, - "virtualNetworkConfiguration": { - "$ref": "#/definitions/VirtualNetworkConfiguration", - "description": "Virtual network configuration of the API Management service." - }, - "additionalLocations": { - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalLocation" - }, - "x-ms-identifiers": [ - "location", - "sku" - ], - "description": "Additional datacenter locations of the API Management service." - }, - "customProperties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Custom properties of the API Management service.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` can be used to disable just TLS 1.1 for communications with backends.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` can be used to disable TLS 1.0 for communications with backends.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` can be used to enable HTTP2 protocol on an API Management service.
Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is `True` if the service was created on or before April 1, 2018 and `False` otherwise. Http2 setting's default value is `False`.

You can disable any of the following ciphers by using settings `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. The default value is `true` for them.
Note: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" - }, - "certificates": { - "type": "array", - "items": { - "$ref": "#/definitions/CertificateConfiguration" - }, - "x-ms-identifiers": [ - "certificate/thumbprint" - ], - "description": "List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10." - }, - "enableClientCertificate": { - "type": "boolean", - "description": "Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.", - "default": false - }, - "natGatewayState": { - "type": "string", - "description": "Property can be used to enable NAT Gateway for this API Management service.", - "default": "Disabled", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "NatGatewayState", - "modelAsString": true, - "values": [ - { - "value": "Enabled", - "description": "Nat Gateway is enabled for the service." - }, - { - "value": "Disabled", - "description": "Nat Gateway is disabled for the service." - } - ] - } - }, - "outboundPublicIPAddresses": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform." - }, - "disableGateway": { - "type": "boolean", - "description": "Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.", - "default": false - }, - "virtualNetworkType": { - "type": "string", - "description": "The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", - "default": "None", - "enum": [ - "None", - "External", - "Internal" - ], - "x-ms-enum": { - "name": "VirtualNetworkType", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "The service is not part of any Virtual Network." - }, - { - "value": "External", - "description": "The service is part of Virtual Network and it is accessible from Internet." - }, - { - "value": "Internal", - "description": "The service is part of Virtual Network and it is only accessible from within the virtual network." - } - ] - } - }, - "apiVersionConstraint": { - "$ref": "#/definitions/ApiVersionConstraint", - "description": "Control Plane Apis version constraint for the API Management service." - }, - "restore": { - "type": "boolean", - "description": "Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.", - "default": false - }, - "privateEndpointConnections": { - "type": "array", - "items": { - "$ref": "./definitions.json#/definitions/RemotePrivateEndpointConnectionWrapper" - }, - "description": "List of Private Endpoint Connections of this service." - }, - "platformVersion": { - "type": "string", - "description": "Compute Platform Version running the service in this location.", - "readOnly": true, - "enum": [ - "undetermined", - "stv1", - "stv2", - "mtv1", - "stv2.1" - ], - "x-ms-enum": { - "name": "PlatformVersion", - "modelAsString": true, - "values": [ - { - "value": "undetermined", - "description": "Platform version cannot be determined, as compute platform is not deployed." - }, - { - "value": "stv1", - "description": "Platform running the service on Single Tenant V1 platform." - }, - { - "value": "stv2", - "description": "Platform running the service on Single Tenant V2 platform." - }, - { - "value": "mtv1", - "description": "Platform running the service on Multi Tenant V1 platform." - }, - { - "value": "stv2.1", - "description": "Platform running the service on Single Tenant V2 platform on newer Hardware." - } - ] - } - }, - "legacyPortalStatus": { - "description": "Status of legacy portal in the API Management service.", - "enum": [ - "Enabled", - "Disabled" - ], - "default": "Enabled", - "type": "string", - "x-ms-enum": { - "name": "LegacyPortalStatus", - "modelAsString": true, - "values": [ - { - "value": "Enabled", - "description": "Legacy Portal is enabled for the service." - }, - { - "value": "Disabled", - "description": "Legacy Portal is disabled for the service." - } - ] - } - }, - "developerPortalStatus": { - "description": "Status of developer portal in this API Management service.", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "default": "Enabled", - "x-ms-enum": { - "name": "developerPortalStatus", - "modelAsString": true, - "values": [ - { - "value": "Enabled", - "description": "Developer Portal is enabled for the service." - }, - { - "value": "Disabled", - "description": "Developer Portal is disabled for the service." - } - ] - } - }, - "releaseChannel": { - "description": "Release Channel of this API Management service.", - "enum": [ - "Preview", - "Default", - "Stable" - ], - "type": "string", - "x-ms-enum": { - "name": "releaseChannel", - "modelAsString": true, - "values": [ - { - "value": "Preview", - "description": "Preview Channel of the service." - }, - { - "value": "Default", - "description": "Default Channel of the service." - }, - { - "value": "Stable", - "description": "Stable Channel of the service." - } - ] - } - } - }, - "description": "Base Properties of an API Management service resource description." - }, - "ApiVersionConstraint": { - "type": "object", - "properties": { - "minApiVersion": { - "type": "string", - "description": "Limit control plane API calls to API Management service with version equal to or newer than this value.", - "example": "2019-01-01" - } - }, - "description": "Control Plane Apis version constraint for the API Management service." - }, - "ApiManagementServiceSkuProperties": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the Sku.", - "externalDocs": { - "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" - }, - "enum": [ - "Developer", - "Standard", - "Premium", - "Basic", - "Consumption", - "Isolated", - "BasicV2", - "StandardV2" - ], - "x-ms-enum": { - "name": "SkuType", - "modelAsString": true, - "values": [ - { - "value": "Developer", - "description": "Developer SKU of Api Management." - }, - { - "value": "Standard", - "description": "Standard SKU of Api Management." - }, - { - "value": "Premium", - "description": "Premium SKU of Api Management." - }, - { - "value": "Basic", - "description": "Basic SKU of Api Management." - }, - { - "value": "Consumption", - "description": "Consumption SKU of Api Management." - }, - { - "value": "Isolated", - "description": "Isolated SKU of Api Management." - }, - { - "value": "BasicV2", - "description": "BasicV2 SKU of Api Management." - }, - { - "value": "StandardV2", - "description": "StandardV2 SKU of Api Management." - } - ] - } - }, - "capacity": { - "type": "integer", - "format": "int32", - "description": "Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0." - } - }, - "required": [ - "name", - "capacity" - ], - "description": "API Management service resource SKU properties." - }, - "ApiManagementServiceResource": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiManagementServiceProperties", - "description": "Properties of the API Management service." - }, - "sku": { - "$ref": "#/definitions/ApiManagementServiceSkuProperties", - "description": "SKU properties of the API Management service." - }, - "identity": { - "$ref": "#/definitions/ApiManagementServiceIdentity", - "description": "Managed service identity of the Api Management service." - }, - "systemData": { - "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", - "description": "Metadata pertaining to creation and last modification of the resource.", - "readOnly": true - }, - "location": { - "type": "string", - "description": "Resource location.", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "etag": { - "type": "string", - "description": "ETag of the resource.", - "readOnly": true - }, - "zones": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of availability zones denoting where the resource needs to come from." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ApimResource" - } - ], - "required": [ - "location", - "sku", - "properties" - ], - "description": "A single API Management service resource in List or Get response." - }, - "ApimResource": { - "type": "object", - "description": "The Resource definition.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource ID." - }, - "name": { - "type": "string", - "description": "Resource name.", - "readOnly": true - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type for API Management resource is set to Microsoft.ApiManagement." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags." - } - }, - "x-ms-azure-resource": true - }, - "ApiManagementServiceUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiManagementServiceUpdateProperties", - "description": "Properties of the API Management service." - }, - "sku": { - "$ref": "#/definitions/ApiManagementServiceSkuProperties", - "description": "SKU properties of the API Management service." - }, - "identity": { - "$ref": "#/definitions/ApiManagementServiceIdentity", - "description": "Managed service identity of the Api Management service." - }, - "etag": { - "type": "string", - "description": "ETag of the resource.", - "readOnly": true - }, - "zones": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of availability zones denoting where the resource needs to come from." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ApimResource" - } - ], - "description": "Parameter supplied to Update Api Management Service." - }, - "ApiManagementServiceListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiManagementServiceResource" - }, - "description": "Result of the List API Management services operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." - } - }, - "required": [ - "value" - ], - "description": "The response of the List API Management services operation." - }, - "ApiManagementServiceGetSsoTokenResult": { - "type": "object", - "properties": { - "redirectUri": { - "type": "string", - "description": "Redirect URL to the Publisher Portal containing the SSO token." - } - }, - "description": "The response of the GetSsoToken operation." - }, - "ApiManagementServiceCheckNameAvailabilityParameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name to check for availability." - } - }, - "required": [ - "name" - ], - "description": "Parameters supplied to the CheckNameAvailability operation." - }, - "ApiManagementServiceNameAvailabilityResult": { - "type": "object", - "properties": { - "nameAvailable": { - "type": "boolean", - "description": "True if the name is available and can be used to create a new API Management service; otherwise false.", - "readOnly": true - }, - "message": { - "type": "string", - "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 is already in use, and direct them to select a different name.", - "readOnly": true - }, - "reason": { - "type": "string", - "description": "Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.", - "enum": [ - "Valid", - "Invalid", - "AlreadyExists" - ], - "x-ms-enum": { - "name": "NameAvailabilityReason", - "modelAsString": false - } - } - }, - "description": "Response of the CheckNameAvailability operation." - }, - "ApiManagementServiceGetDomainOwnershipIdentifierResult": { - "type": "object", - "properties": { - "domainOwnershipIdentifier": { - "type": "string", - "description": "The domain ownership identifier value.", - "readOnly": true - } - }, - "description": "Response of the GetDomainOwnershipIdentifier operation." - }, - "ApiManagementServiceApplyNetworkConfigurationParameters": { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required." - } - }, - "description": "Parameter supplied to the Apply Network configuration operation." - }, - "ApiManagementServiceIdentity": { - "type": "object", - "description": "Identity properties of the Api Management service resource.", - "properties": { - "type": { - "type": "string", - "description": "The type of identity used for the resource. 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 service.", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" - ], - "x-ms-enum": { - "name": "ApimIdentityType", - "modelAsString": true - } - }, - "principalId": { - "type": "string", - "format": "uuid", - "readOnly": true, - "description": "The principal id of the identity." - }, - "tenantId": { - "type": "string", - "format": "uuid", - "readOnly": true, - "description": "The client tenant id of the identity." - }, - "userAssignedIdentities": { - "description": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/UserIdentityProperties" - } - } - }, - "required": [ - "type" - ] - }, - "UserIdentityProperties": { - "type": "object", - "properties": { - "principalId": { - "description": "The principal id of user assigned identity.", - "type": "string" - }, - "clientId": { - "description": "The client id of user assigned identity.", - "type": "string" - } - } - }, - "Operation": { - "description": "REST API operation", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "The object that describes the operation.", - "properties": { - "provider": { - "description": "Friendly name of the resource provider", - "type": "string" - }, - "operation": { - "description": "Operation type: read, write, delete, listKeys/action, etc.", - "type": "string" - }, - "resource": { - "description": "Resource type on which the operation is performed.", - "type": "string" - }, - "description": { - "description": "Friendly name of the operation", - "type": "string" - } - } - }, - "origin": { - "type": "string", - "description": "The operation origin." - }, - "properties": { - "type": "object", - "x-ms-client-flatten": true, - "description": "The operation properties." - } - } - }, - "OperationListResult": { - "type": "object", - "description": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", - "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." - } - } - } - }, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimdiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimdiagnostics.json deleted file mode 100644 index e076b79bab84..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimdiagnostics.json +++ /dev/null @@ -1,376 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Diagnostic entity associated with your Azure API Management deployment. Diagnostics are used to log requests/responses in the API Management proxy.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/diagnostics": { - "get": { - "tags": [ - "Diagnostic" - ], - "operationId": "Diagnostic_ListByService", - "description": "Lists all diagnostics of the API Management service instance.", - "x-ms-examples": { - "ApiManagementListDiagnostics": { - "$ref": "./examples/ApiManagementListDiagnostics.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Paged Result response of diagnostics.", - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticCollection" - } - }, - "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-odata": "./definitions.json#/definitions/DiagnosticContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}": { - "head": { - "tags": [ - "Diagnostic" - ], - "operationId": "Diagnostic_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Diagnostic specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadDiagnostic": { - "$ref": "./examples/ApiManagementHeadDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the entity tag of the diagnostic", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Diagnostic" - ], - "operationId": "Diagnostic_Get", - "description": "Gets the details of the Diagnostic specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetDiagnostic": { - "$ref": "./examples/ApiManagementGetDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Diagnostic entity.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Diagnostic" - ], - "operationId": "Diagnostic_CreateOrUpdate", - "description": "Creates a new Diagnostic or updates an existing one.", - "x-ms-examples": { - "ApiManagementCreateDiagnostic": { - "$ref": "./examples/ApiManagementCreateDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Diagnostic was successfully created.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - } - }, - "200": { - "description": "Diagnostic successfully updated", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Diagnostic" - ], - "operationId": "Diagnostic_Update", - "description": "Updates the details of the Diagnostic specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateDiagnostic": { - "$ref": "./examples/ApiManagementUpdateDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "description": "Diagnostic Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Diagnostic successfully updated", - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Diagnostic" - ], - "operationId": "Diagnostic_Delete", - "description": "Deletes the specified Diagnostic.", - "x-ms-examples": { - "ApiManagementDeleteDiagnostic": { - "$ref": "./examples/ApiManagementDeleteDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The Diagnostic was successfully deleted." - }, - "204": { - "description": "The Diagnostic was successfully deleted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimdocumentations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimdocumentations.json deleted file mode 100644 index 72c64fc0984c..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimdocumentations.json +++ /dev/null @@ -1,376 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Documentation entity.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/documentations": { - "get": { - "tags": [ - "Documentation" - ], - "operationId": "Documentation_ListByService", - "description": "Lists all Documentations of the API Management service instance.", - "x-ms-examples": { - "ApiManagementListApis": { - "$ref": "./examples/ApiManagementListDocumentations.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Paged Result response of Documentations.", - "schema": { - "$ref": "./definitions.json#/definitions/DocumentationCollection" - } - }, - "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-odata": "./definitions.json#/definitions/DocumentationContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}": { - "head": { - "tags": [ - "Documentation" - ], - "operationId": "Documentation_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Documentation by its identifier.", - "x-ms-examples": { - "ApiManagementHeadDocumentation": { - "$ref": "./examples/ApiManagementHeadDocumentation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DocumentationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Documentation" - ], - "operationId": "Documentation_Get", - "description": "Gets the details of the Documentation specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetDocumentation": { - "$ref": "./examples/ApiManagementGetDocumentation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DocumentationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Documentation entity.", - "schema": { - "$ref": "./definitions.json#/definitions/DocumentationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Documentation" - ], - "operationId": "Documentation_CreateOrUpdate", - "description": "Creates a new Documentation or updates an existing one.", - "x-ms-examples": { - "ApiManagementCreateDocumentation": { - "$ref": "./examples/ApiManagementCreateDocumentation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DocumentationIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/DocumentationContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Documentation was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/DocumentationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Documentation was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/DocumentationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Documentation" - ], - "operationId": "Documentation_Update", - "description": "Updates the details of the Documentation for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateDocumentation": { - "$ref": "./examples/ApiManagementUpdateDocumentation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DocumentationIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/DocumentationUpdateContract" - }, - "description": "Documentation Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Documentation was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/DocumentationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Documentation" - ], - "operationId": "Documentation_Delete", - "description": "Deletes the specified Documentation from an API.", - "x-ms-examples": { - "ApiManagementDeleteDocumentation": { - "$ref": "./examples/ApiManagementDeleteDocumentation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DocumentationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Documentation successfully removed" - }, - "204": { - "description": "Documentation successfully removed by previous request or does not exist" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimemailtemplates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimemailtemplates.json deleted file mode 100644 index fe1022599e31..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimemailtemplates.json +++ /dev/null @@ -1,363 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Email Templates associated with your Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/templates": { - "get": { - "tags": [ - "EmailTemplate" - ], - "operationId": "EmailTemplate_ListByService", - "description": "Gets all email templates", - "x-ms-examples": { - "ApiManagementListTemplates": { - "$ref": "./examples/ApiManagementListTemplates.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A Collection of the Email Template for the specified API Management service instance.", - "schema": { - "$ref": "./definitions.json#/definitions/EmailTemplateCollection" - } - }, - "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.ApiManagement/service/{serviceName}/templates/{templateName}": { - "head": { - "tags": [ - "EmailTemplates" - ], - "operationId": "EmailTemplate_GetEntityTag", - "description": "Gets the entity state (Etag) version of the email template specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadEmailTemplate": { - "$ref": "./examples/ApiManagementHeadEmailTemplate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified email template entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "EmailTemplates" - ], - "operationId": "EmailTemplate_Get", - "description": "Gets the details of the email template specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetTemplate": { - "$ref": "./examples/ApiManagementGetTemplate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Email template.", - "schema": { - "$ref": "./definitions.json#/definitions/EmailTemplateContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "EmailTemplates" - ], - "operationId": "EmailTemplate_CreateOrUpdate", - "description": "Updates an Email Template.", - "x-ms-examples": { - "ApiManagementCreateTemplate": { - "$ref": "./examples/ApiManagementCreateTemplate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/EmailTemplateUpdateParameters" - }, - "description": "Email Template update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Email Template was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/EmailTemplateContract" - } - }, - "200": { - "description": "Email Template was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/EmailTemplateContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "EmailTemplates" - ], - "operationId": "EmailTemplate_Update", - "description": "Updates API Management email template", - "x-ms-examples": { - "ApiManagementUpdateTemplate": { - "$ref": "./examples/ApiManagementUpdateTemplate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/EmailTemplateUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "email template successfully updated", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/EmailTemplateContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "EmailTemplates" - ], - "operationId": "EmailTemplate_Delete", - "description": "Reset the Email Template to default template provided by the API Management service instance.", - "x-ms-examples": { - "ApiManagementDeleteTemplate": { - "$ref": "./examples/ApiManagementDeleteTemplate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TemplateNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Email Template was successfully reset to default." - }, - "204": { - "description": "Email Template was successfully reset to default." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimgatewayConfigConnections.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimgatewayConfigConnections.json deleted file mode 100644 index 64a29aa1a3ac..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimgatewayConfigConnections.json +++ /dev/null @@ -1,324 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs to manage Azure API Management gateway config connections deployments.", - "version": "2024-10-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.ApiManagement/gateways/{gatewayName}/configConnections": { - "get": { - "tags": [ - "ApiGatewayConfigConnection" - ], - "operationId": "ApiGatewayConfigConnection_ListByGateway", - "description": "List all API Management gateway config connections within a gateway.", - "x-ms-examples": { - "ApiManagementListGatewayConfigConnection": { - "$ref": "./examples/ApiManagementListGatewayConfigConnection.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" - } - ], - "responses": { - "200": { - "description": "The API Management gateway config connection list.", - "schema": { - "$ref": "#/definitions/ApiManagementGatewayConfigConnectionListResult" - } - }, - "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.ApiManagement/gateways/{gatewayName}/configConnections/{configConnectionName}": { - "get": { - "tags": [ - "ApiGatewayConfigConnection" - ], - "operationId": "ApiGatewayConfigConnection_Get", - "description": "Gets an API Management gateway config connection resource description.", - "x-ms-examples": { - "ApiManagementGetGatewayConfigConnection": { - "$ref": "./examples/ApiManagementGetGatewayConfigConnection.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ConfigConnectionNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully got the API Management gateway config connection resource.", - "schema": { - "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiGatewayConfigConnection" - ], - "operationId": "ApiGatewayConfigConnection_CreateOrUpdate", - "description": "Creates or updates an API Management gateway config connection. This is long running operation and could take several minutes to complete.", - "x-ms-examples": { - "ApiManagementCreateGatewayConfigConnection": { - "$ref": "./examples/ApiManagementCreateGatewayConfigConnection.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ConfigConnectionNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" - }, - "description": "Parameters supplied to the CreateOrUpdate API Management gateway config connection operation." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The gateway config connection was successfully updated.", - "schema": { - "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" - } - }, - "201": { - "description": "The gateway config connection was successfully created.", - "schema": { - "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" - } - }, - "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": [ - "ApiGatewayConfigConnection" - ], - "operationId": "ApiGatewayConfigConnection_Delete", - "description": "Deletes an existing API Management gateway config connection.", - "x-ms-examples": { - "ApiManagementGatewayDeleteGateway": { - "$ref": "./examples/ApiManagementDeleteGatewayConfigConnection.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ConfigConnectionNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "The gateway config connection delete request was accepted.", - "headers": { - "location": { - "description": "Location header", - "type": "string" - } - } - }, - "204": { - "description": "The gateway config 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 - } - } - }, - "definitions": { - "GatewayConfigConnectionBaseProperties": { - "type": "object", - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The current provisioning state of the API Management gateway config connection " - }, - "sourceId": { - "type": "string", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ApiManagement/service/workspaces" - } - ] - }, - "description": "The link to the API Management service workspace." - }, - "defaultHostname": { - "readOnly": true, - "type": "string", - "description": "The default hostname of the data-plane gateway." - }, - "hostnames": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The hostnames of the data-plane gateway to which requests can be sent." - } - } - }, - "ApiManagementGatewayConfigConnectionResource": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/GatewayConfigConnectionBaseProperties", - "description": "Properties of the API Management gateway config connection." - }, - "etag": { - "type": "string", - "description": "ETag of the resource.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "required": [ - "properties" - ], - "description": "A single API Management gateway resource in List or Get response." - }, - "ApiManagementGatewayConfigConnectionListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" - }, - "description": "Result of the List API Management gateway config connection operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." - } - }, - "required": [ - "value" - ], - "description": "The response of the List API Management gateway operation." - } - }, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimgateways.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimgateways.json deleted file mode 100644 index 603c638e0f9c..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimgateways.json +++ /dev/null @@ -1,1475 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Gateway entity in Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/gateways": { - "get": { - "tags": [ - "Gateway" - ], - "operationId": "Gateway_ListByService", - "description": "Lists a collection of gateways registered with service instance.", - "x-ms-examples": { - "ApiManagementListGateways": { - "$ref": "./examples/ApiManagementListGateways.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| region | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Gateway entities.", - "schema": { - "$ref": "./definitions.json#/definitions/GatewayCollection" - } - }, - "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-odata": "./definitions.json#/definitions/GatewayContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}": { - "head": { - "tags": [ - "Gateway" - ], - "operationId": "Gateway_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Gateway specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadGateway": { - "$ref": "./examples/ApiManagementHeadGateway.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified Gateway entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Gateway" - ], - "operationId": "Gateway_Get", - "description": "Gets the details of the Gateway specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetGateway": { - "$ref": "./examples/ApiManagementGetGateway.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Gateway entity.", - "schema": { - "$ref": "./definitions.json#/definitions/GatewayContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Gateway" - ], - "operationId": "Gateway_CreateOrUpdate", - "description": "Creates or updates a Gateway to be used in Api Management instance.", - "x-ms-examples": { - "ApiManagementCreateGateway": { - "$ref": "./examples/ApiManagementCreateGateway.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayContract" - } - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "The new Gateway was successfully added.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayContract" - } - }, - "200": { - "description": "The Gateway details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Gateway" - ], - "operationId": "Gateway_Update", - "description": "Updates the details of the gateway specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateGateway": { - "$ref": "./examples/ApiManagementUpdateGateway.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayContract" - } - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The Gateway details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Gateway" - ], - "operationId": "Gateway_Delete", - "description": "Deletes specific Gateway.", - "x-ms-examples": { - "ApiManagementDeleteGateway": { - "$ref": "./examples/ApiManagementDeleteGateway.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The Gateway was successfully deleted." - }, - "204": { - "description": "The Gateway was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys": { - "post": { - "tags": [ - "GatewayListKeys" - ], - "operationId": "Gateway_ListKeys", - "description": "Retrieves gateway keys.", - "x-ms-examples": { - "ApiManagementGatewayListKeys": { - "$ref": "./examples/ApiManagementGatewayListKeys.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Gateway keys.", - "schema": { - "$ref": "./definitions.json#/definitions/GatewayKeysContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/regenerateKey": { - "post": { - "tags": [ - "GatewayRegenerateKey" - ], - "operationId": "Gateway_RegenerateKey", - "description": "Regenerates specified gateway key invalidating any tokens created with it.", - "x-ms-examples": { - "ApiManagementGatewayRegenerateKey": { - "$ref": "./examples/ApiManagementGatewayRegenerateKey.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayKeyRegenerationRequestContract" - } - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "Key successfully regenerated" - }, - "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken": { - "post": { - "tags": [ - "GatewayGenerateToken" - ], - "operationId": "Gateway_GenerateToken", - "description": "Gets the Shared Access Authorization Token for the gateway.", - "x-ms-examples": { - "ApiManagementGatewayGenerateToken": { - "$ref": "./examples/ApiManagementGatewayGenerateToken.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayTokenRequestContract" - } - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the authorization token for the gateway.", - "schema": { - "$ref": "./definitions.json#/definitions/GatewayTokenContract" - } - }, - "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations": { - "get": { - "tags": [ - "GatewayHostnameConfiguration" - ], - "operationId": "GatewayHostnameConfiguration_ListByService", - "description": "Lists the collection of hostname configurations for the specified gateway.", - "x-ms-examples": { - "ApiManagementListGatewayHostnameConfigurations": { - "$ref": "./examples/ApiManagementListGatewayHostnameConfigurations.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| hostname | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Collection of hostname configuration entities.", - "schema": { - "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationCollection" - } - }, - "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-odata": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}": { - "head": { - "tags": [ - "GatewayHostnameConfiguration" - ], - "operationId": "GatewayHostnameConfiguration_GetEntityTag", - "description": "Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.", - "x-ms-examples": { - "ApiManagementHeadGatewayHostnameConfiguration": { - "$ref": "./examples/ApiManagementHeadGatewayHostnameConfiguration.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayHostnameConfigurationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified Gateway entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "GatewayHostnameConfiguration" - ], - "operationId": "GatewayHostnameConfiguration_Get", - "description": "Get details of a hostname configuration", - "x-ms-examples": { - "ApiManagementGetGatewayHostnameConfiguration": { - "$ref": "./examples/ApiManagementGetGatewayHostnameConfiguration.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayHostnameConfigurationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Gateway entity.", - "schema": { - "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "GatewayHostnameConfiguration" - ], - "operationId": "GatewayHostnameConfiguration_CreateOrUpdate", - "description": "Creates of updates hostname configuration for a Gateway.", - "x-ms-examples": { - "ApiManagementCreateGatewayHostnameConfiguration": { - "$ref": "./examples/ApiManagementCreateGatewayHostnameConfiguration.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayHostnameConfigurationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" - } - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "The new Gateway hostname configuration was successfully created.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" - } - }, - "200": { - "description": "The Gateway hostname configuration details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayHostnameConfigurationContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "GatewayHostnameConfiguration" - ], - "operationId": "GatewayHostnameConfiguration_Delete", - "description": "Deletes the specified hostname configuration from the specified Gateway.", - "x-ms-examples": { - "ApiManagementDeleteGatewayHostnameConfiguration": { - "$ref": "./examples/ApiManagementDeleteGatewayHostnameConfiguration.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayHostnameConfigurationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Hostname configuration was successfully removed from Gateway." - }, - "204": { - "description": "Hostname configuration successfully removed by previous request or does not exist in Gateway." - }, - "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis": { - "get": { - "tags": [ - "GatewayApi" - ], - "operationId": "GatewayApi_ListByService", - "description": "Lists a collection of the APIs associated with a gateway.", - "x-ms-examples": { - "ApiManagementListGatewayApis": { - "$ref": "./examples/ApiManagementListGatewayApis.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains a collection of Api entities in the gateway.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ApiContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}": { - "head": { - "tags": [ - "GatewayApi" - ], - "operationId": "GatewayApi_GetEntityTag", - "description": "Checks that API entity specified by identifier is associated with the Gateway entity.", - "x-ms-examples": { - "ApiManagementHeadGatewayApi": { - "$ref": "./examples/ApiManagementHeadGatewayApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified Gateway entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "GatewayApi" - ], - "operationId": "GatewayApi_CreateOrUpdate", - "description": "Adds an API to the specified Gateway.", - "x-ms-examples": { - "ApiManagementCreateGatewayApi": { - "$ref": "./examples/ApiManagementCreateGatewayApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": false, - "schema": { - "$ref": "./definitions.json#/definitions/AssociationContract" - } - } - ], - "responses": { - "201": { - "description": "The API was successfully added to the Gateway.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiContract" - } - }, - "200": { - "description": "The specified API is already added to the Gateway.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "GatewayApi" - ], - "operationId": "GatewayApi_Delete", - "description": "Deletes the specified API from the specified Gateway.", - "x-ms-examples": { - "ApiManagementDeleteGatewayApi": { - "$ref": "./examples/ApiManagementDeleteGatewayApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "API was successfully removed from Gateway" - }, - "204": { - "description": "API successfully removed by previous request or does not exist in Gateway" - }, - "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities": { - "get": { - "tags": [ - "GatewayCertificateAuthority" - ], - "operationId": "GatewayCertificateAuthority_ListByService", - "description": "Lists the collection of Certificate Authorities for the specified Gateway entity.", - "x-ms-examples": { - "ApiManagementListGatewaycertificateAuthorities": { - "$ref": "./examples/ApiManagementListGatewayCertificateAuthorities.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq, ne | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Collection of Gateway Certificate Authority entities.", - "schema": { - "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityCollection" - } - }, - "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-odata": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}": { - "head": { - "tags": [ - "GatewayCertificateAuthority" - ], - "operationId": "GatewayCertificateAuthority_GetEntityTag", - "description": "Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.", - "x-ms-examples": { - "ApiManagementHeadGatewayCertificateAuthority": { - "$ref": "./examples/ApiManagementHeadGatewayCertificateAuthority.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified Gateway Certificate Authority entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "GatewayCertificateAuthority" - ], - "operationId": "GatewayCertificateAuthority_Get", - "description": "Get assigned Gateway Certificate Authority details.", - "x-ms-examples": { - "ApiManagementGetGatewayCertificateAuthority": { - "$ref": "./examples/ApiManagementGetGatewayCertificateAuthority.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Gateway Certificate Authority entity.", - "schema": { - "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "GatewayCertificateAuthority" - ], - "operationId": "GatewayCertificateAuthority_CreateOrUpdate", - "description": "Assign Certificate entity to Gateway entity as Certificate Authority.", - "x-ms-examples": { - "ApiManagementCreateGatewayCertificateAuthority": { - "$ref": "./examples/ApiManagementCreateGatewayCertificateAuthority.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" - } - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Certificate entity was successfully assigned to Gateway entity as Certificate Authority.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" - } - }, - "200": { - "description": "Gateway Certificate Authority details were successfully updated", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "GatewayCertificateAuthority" - ], - "operationId": "GatewayCertificateAuthority_Delete", - "description": "Remove relationship between Certificate Authority and Gateway entity.", - "x-ms-examples": { - "ApiManagementDeleteGatewayCertificateAuthority": { - "$ref": "./examples/ApiManagementDeleteGatewayCertificateAuthority.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Certificate entity was successfully removed from Gateway entity as Certificate Authority." - }, - "204": { - "description": "Certificate was successfully removed from Gateway entity as Certificate Authority by one of the previous requests or never assigned." - }, - "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/invalidateDebugCredentials": { - "post": { - "tags": [ - "GatewayInvalidateDebugCredentials" - ], - "operationId": "Gateway_InvalidateDebugCredentials", - "description": "Action is invalidating all debug credentials issued for gateway.", - "x-ms-examples": { - "ApiManagementGatewayInvalidateDebugCredentials": { - "$ref": "./examples/ApiManagementGatewayInvalidateDebugCredentials.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "All debug credentials for gateway are now invalidated." - }, - "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listDebugCredentials": { - "post": { - "tags": [ - "GatewayListDebugCredentials" - ], - "operationId": "Gateway_ListDebugCredentials", - "description": "Create new debug credentials for gateway.", - "x-ms-examples": { - "ApiManagementGatewayListDebugCredentials": { - "$ref": "./examples/ApiManagementGatewayListDebugCredentials.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "description": "List debug credentials properties.", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayListDebugCredentialsContract" - } - } - ], - "responses": { - "200": { - "description": "The response body contains debug credentials to use in gateway.", - "schema": { - "$ref": "./definitions.json#/definitions/GatewayDebugCredentialsContract" - } - }, - "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.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listTrace": { - "post": { - "tags": [ - "GatewayListTrace" - ], - "operationId": "Gateway_ListTrace", - "description": "Fetches trace collected by gateway.", - "x-ms-examples": { - "ApiManagementGatewayListTrace": { - "$ref": "./examples/ApiManagementGatewayListTrace.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GatewayIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "description": "List trace properties.", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/GatewayListTraceContract" - } - } - ], - "responses": { - "200": { - "description": "The response body contains trace collected by gateway.", - "schema": { - "$ref": "./definitions.json#/definitions/GatewayTraceContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimgroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimgroups.json deleted file mode 100644 index c818a5d97e8b..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimgroups.json +++ /dev/null @@ -1,590 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Group entity in your Azure API Management deployment. Groups are used to manage the visibility of products to developers. Each API Management service instance comes with the following immutable system groups whose membership is automatically managed by API Management. - **Administrators** - Azure subscription administrators are members of this group. - **Developers** - Authenticated developer portal users fall into this group. - **Guests** - Unauthenticated developer portal users are placed into this group. In addition to these system groups, administrators can create custom groups or [leverage external groups in associated Azure Active Directory tenants](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-aad#how-to-add-an-external-azure-active-directory-group). Custom and external groups can be used alongside system groups in giving developers visibility and access to API products. For example, you could create one custom group for developers affiliated with a specific partner organization and allow them access to the APIs from a product containing relevant APIs only. A user can be a member of more than one group.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/groups": { - "get": { - "tags": [ - "Group" - ], - "operationId": "Group_ListByService", - "description": "Lists a collection of groups defined within a service instance.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-groups" - }, - "x-ms-examples": { - "ApiManagementListGroups": { - "$ref": "./examples/ApiManagementListGroups.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| externalId | filter | eq | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Group entities.", - "schema": { - "$ref": "./definitions.json#/definitions/GroupCollection" - } - }, - "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-odata": "./definitions.json#/definitions/GroupContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}": { - "head": { - "tags": [ - "Group" - ], - "operationId": "Group_GetEntityTag", - "description": "Gets the entity state (Etag) version of the group specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadGroup": { - "$ref": "./examples/ApiManagementHeadGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified group entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Group" - ], - "operationId": "Group_Get", - "description": "Gets the details of the group specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetGroup": { - "$ref": "./examples/ApiManagementGetGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Group entity.", - "schema": { - "$ref": "./definitions.json#/definitions/GroupContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Group" - ], - "operationId": "Group_CreateOrUpdate", - "description": "Creates or Updates a group.", - "x-ms-examples": { - "ApiManagementCreateGroup": { - "$ref": "./examples/ApiManagementCreateGroup.json" - }, - "ApiManagementCreateGroupExternal": { - "$ref": "./examples/ApiManagementCreateGroupExternal.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/GroupCreateParameters" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Group was created successfully.", - "schema": { - "$ref": "./definitions.json#/definitions/GroupContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Group already exists.", - "schema": { - "$ref": "./definitions.json#/definitions/GroupContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Group" - ], - "operationId": "Group_Update", - "description": "Updates the details of the group specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateGroup": { - "$ref": "./examples/ApiManagementUpdateGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/GroupUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The group details were successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/GroupContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Group" - ], - "operationId": "Group_Delete", - "description": "Deletes specific group of the API Management service instance.", - "x-ms-examples": { - "ApiManagementDeleteGroup": { - "$ref": "./examples/ApiManagementDeleteGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The group was successfully deleted." - }, - "204": { - "description": "The group was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/groups/{groupId}/users": { - "get": { - "tags": [ - "GroupUser" - ], - "operationId": "GroupUser_List", - "description": "Lists a collection of user entities associated with the group.", - "x-ms-examples": { - "ApiManagementListGroupUsers": { - "$ref": "./examples/ApiManagementListGroupUsers.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of user entities associated with the group.", - "schema": { - "$ref": "./definitions.json#/definitions/UserCollection" - } - }, - "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-odata": "./definitions.json#/definitions/UserContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}": { - "head": { - "tags": [ - "GroupUser" - ], - "operationId": "GroupUser_CheckEntityExists", - "description": "Checks that user entity specified by identifier is associated with the group entity.", - "x-ms-examples": { - "ApiManagementHeadGroupUser": { - "$ref": "./examples/ApiManagementHeadGroupUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "Entity exists" - }, - "404": { - "description": "Entity does not exists." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "GroupUser" - ], - "operationId": "GroupUser_Create", - "description": "Add existing user to existing group", - "x-ms-examples": { - "ApiManagementCreateGroupUser": { - "$ref": "./examples/ApiManagementCreateGroupUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "The user was successfully added to the group.", - "schema": { - "$ref": "./definitions.json#/definitions/UserContract" - } - }, - "200": { - "description": "The specified user is already a member of the specified group.", - "schema": { - "$ref": "./definitions.json#/definitions/UserContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "GroupUser" - ], - "operationId": "GroupUser_Delete", - "description": "Remove existing user from existing group.", - "x-ms-examples": { - "ApiManagementDeleteGroupUser": { - "$ref": "./examples/ApiManagementDeleteGroupUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The user was successfully removed from the group." - }, - "204": { - "description": "The user was successfully removed from the group." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimidentityprovider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimidentityprovider.json deleted file mode 100644 index 19298e1f55be..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimidentityprovider.json +++ /dev/null @@ -1,416 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Identity Provider entity associated with your Azure API Management deployment. Setting up an external Identity Provider for authentication can help you manage the developer portal logins using the OAuth2 flow.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/identityProviders": { - "get": { - "tags": [ - "IdentityProvider" - ], - "operationId": "IdentityProvider_ListByService", - "description": "Lists a collection of Identity Provider configured in the specified service instance.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-aad#how-to-authorize-developer-accounts-using-azure-active-directory" - }, - "x-ms-examples": { - "ApiManagementListIdentityProviders": { - "$ref": "./examples/ApiManagementListIdentityProviders.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Identity Providers.", - "schema": { - "$ref": "./definitions.json#/definitions/IdentityProviderList" - } - }, - "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.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}": { - "head": { - "tags": [ - "IdentityProvider" - ], - "operationId": "IdentityProvider_GetEntityTag", - "description": "Gets the entity state (Etag) version of the identityProvider specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadIdentityProvider": { - "$ref": "./examples/ApiManagementHeadIdentityProvider.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified identity provider entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "IdentityProvider" - ], - "operationId": "IdentityProvider_Get", - "description": "Gets the configuration details of the identity Provider configured in specified service instance.", - "x-ms-examples": { - "ApiManagementGetIdentityProvider": { - "$ref": "./examples/ApiManagementGetIdentityProvider.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified IdentityProvider entity configuration details.", - "schema": { - "$ref": "./definitions.json#/definitions/IdentityProviderContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "IdentityProvider" - ], - "operationId": "IdentityProvider_CreateOrUpdate", - "description": "Creates or Updates the IdentityProvider configuration.", - "x-ms-examples": { - "ApiManagementCreateIdentityProvider": { - "$ref": "./examples/ApiManagementCreateIdentityProvider.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/IdentityProviderCreateContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "IdentityProvider configuration were successfully created.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/IdentityProviderContract" - } - }, - "200": { - "description": "The existing Identity Provider was successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/IdentityProviderContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "IdentityProvider" - ], - "operationId": "IdentityProvider_Update", - "description": "Updates an existing IdentityProvider configuration.", - "x-ms-examples": { - "ApiManagementUpdateIdentityProvider": { - "$ref": "./examples/ApiManagementUpdateIdentityProvider.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/IdentityProviderUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The existing Identity Provider was successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/IdentityProviderContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "IdentityProvider" - ], - "operationId": "IdentityProvider_Delete", - "description": "Deletes the specified identity provider configuration.", - "x-ms-examples": { - "ApiManagementDeleteIdentityProvider": { - "$ref": "./examples/ApiManagementDeleteIdentityProvider.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The identity provider configuration was successfully deleted." - }, - "204": { - "description": "The identity provider configuration was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}/listSecrets": { - "post": { - "tags": [ - "IdentityProvider" - ], - "operationId": "IdentityProvider_ListSecrets", - "description": "Gets the client secret details of the Identity Provider.", - "x-ms-examples": { - "ApiManagementIdentityProviderListSecrets": { - "$ref": "./examples/ApiManagementIdentityProviderListSecrets.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdentityProviderNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the client secret.", - "schema": { - "$ref": "./definitions.json#/definitions/ClientSecretContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimissues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimissues.json deleted file mode 100644 index 8e1452ae62c7..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimissues.json +++ /dev/null @@ -1,150 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use this REST API to get all the issues across an Azure Api Management service.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/issues": { - "get": { - "tags": [ - "Issue" - ], - "operationId": "Issue_ListByService", - "description": "Lists a collection of issues in the specified service instance.", - "x-ms-examples": { - "ApiManagementListIssues": { - "$ref": "./examples/ApiManagementListIssues.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| authorName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Issue entities.", - "schema": { - "$ref": "./definitions.json#/definitions/IssueCollection" - } - }, - "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-odata": "./definitions.json#/definitions/IssueContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues/{issueId}": { - "get": { - "tags": [ - "Issue" - ], - "operationId": "Issue_Get", - "description": "Gets API Management issue details", - "x-ms-examples": { - "ApiManagementGetIssue": { - "$ref": "./examples/ApiManagementGetIssue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IssueIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Get the details of the issue.", - "schema": { - "$ref": "./definitions.json#/definitions/IssueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimloggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimloggers.json deleted file mode 100644 index 09808b50c5ab..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimloggers.json +++ /dev/null @@ -1,382 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on logger entity Azure API Management deployment.The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure EventHub.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/loggers": { - "get": { - "tags": [ - "Logger" - ], - "operationId": "Logger_ListByService", - "description": "Lists a collection of loggers in the specified service instance.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-log-event-hubs" - }, - "x-ms-examples": { - "ApiManagementListLoggers": { - "$ref": "./examples/ApiManagementListLoggers.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| loggerType | filter | eq | |
| resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Logger entities.", - "schema": { - "$ref": "./definitions.json#/definitions/LoggerCollection" - } - }, - "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-odata": "./definitions.json#/definitions/LoggerContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}": { - "head": { - "tags": [ - "Logger" - ], - "operationId": "Logger_GetEntityTag", - "description": "Gets the entity state (Etag) version of the logger specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadLogger": { - "$ref": "./examples/ApiManagementHeadLogger.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified logger entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Logger" - ], - "operationId": "Logger_Get", - "description": "Gets the details of the logger specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetLogger": { - "$ref": "./examples/ApiManagementGetLogger.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Logger entity.", - "schema": { - "$ref": "./definitions.json#/definitions/LoggerContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Logger" - ], - "operationId": "Logger_CreateOrUpdate", - "description": "Creates or Updates a logger.", - "x-ms-examples": { - "ApiManagementCreateEHLogger": { - "$ref": "./examples/ApiManagementCreateEHLogger.json" - }, - "ApiManagementCreateAILogger": { - "$ref": "./examples/ApiManagementCreateAILogger.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/LoggerContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Logger was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/LoggerContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "The existing logger was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/LoggerContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Logger" - ], - "operationId": "Logger_Update", - "description": "Updates an existing logger.", - "x-ms-examples": { - "ApiManagementUpdateLogger": { - "$ref": "./examples/ApiManagementUpdateLogger.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/LoggerUpdateContract" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The existing logger was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/LoggerContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Logger" - ], - "operationId": "Logger_Delete", - "description": "Deletes the specified logger.", - "x-ms-examples": { - "ApiManagementDeleteLogger": { - "$ref": "./examples/ApiManagementDeleteLogger.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The logger was successfully deleted." - }, - "204": { - "description": "The logger was successfully deleted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimnamedvalues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimnamedvalues.json deleted file mode 100644 index 6658434b5ea1..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimnamedvalues.json +++ /dev/null @@ -1,548 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on NamedValue entity associated with your Azure API Management deployment. API Management policies are a powerful capability of the system that allow the publisher to change the behavior of the API through configuration. Policies are a collection of statements that are executed sequentially on the request or response of an API. Policy statements can be constructed using literal text values, policy expressions, and NamedValues. Each API Management service instance has a NamedValues collection of key/value pairs that are global to the service instance. These NamedValues can be used to manage constant string values across all API configuration and policies.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/namedValues": { - "get": { - "tags": [ - "NamedValue" - ], - "operationId": "NamedValue_ListByService", - "description": "Lists a collection of named values defined within a service instance.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties" - }, - "x-ms-examples": { - "ApiManagementListNamedValues": { - "$ref": "./examples/ApiManagementListNamedValues.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "isKeyVaultRefreshFailed", - "in": "query", - "required": false, - "type": "boolean", - "description": "When set to true, the response contains only named value entities which failed refresh." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A Collection of the named value entities for the specified API Management service instance.", - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueCollection" - } - }, - "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-odata": "./definitions.json#/definitions/NamedValueContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}": { - "head": { - "tags": [ - "NamedValue" - ], - "operationId": "NamedValue_GetEntityTag", - "description": "Gets the entity state (Etag) version of the named value specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadNamedValue": { - "$ref": "./examples/ApiManagementHeadNamedValue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified named value entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "NamedValue" - ], - "operationId": "NamedValue_Get", - "description": "Gets the details of the named value specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetNamedValue": { - "$ref": "./examples/ApiManagementGetNamedValue.json" - }, - "ApiManagementGetNamedValueWithKeyVault": { - "$ref": "./examples/ApiManagementGetNamedValueWithKeyVault.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified named value entity. No secrets included", - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "NamedValue" - ], - "operationId": "NamedValue_CreateOrUpdate", - "description": "Creates or updates named value.", - "x-ms-examples": { - "ApiManagementCreateNamedValue": { - "$ref": "./examples/ApiManagementCreateNamedValue.json" - }, - "ApiManagementCreateNamedValueWithKeyVault": { - "$ref": "./examples/ApiManagementCreateNamedValueWithKeyVault.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueCreateContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Named value was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "200": { - "description": "Named value was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "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" - } - }, - "patch": { - "tags": [ - "NamedValue" - ], - "operationId": "NamedValue_Update", - "description": "Updates the specific named value.", - "x-ms-examples": { - "ApiManagementUpdateNamedValue": { - "$ref": "./examples/ApiManagementUpdateNamedValue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "Request to create or update named value was accepted.", - "headers": { - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "200": { - "description": "Named value was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "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" - } - }, - "delete": { - "tags": [ - "NamedValue" - ], - "operationId": "NamedValue_Delete", - "description": "Deletes specific named value from the API Management service instance.", - "x-ms-examples": { - "ApiManagementDeleteNamedValue": { - "$ref": "./examples/ApiManagementDeleteNamedValue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Named value was successfully deleted." - }, - "204": { - "description": "Named value was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/namedValues/{namedValueId}/listValue": { - "post": { - "tags": [ - "NamedValue" - ], - "operationId": "NamedValue_ListValue", - "description": "Gets the secret of the named value specified by its identifier.", - "x-ms-examples": { - "ApiManagementNamedValueListValue": { - "$ref": "./examples/ApiManagementNamedValueListValue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified named value secret.", - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueSecretContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "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.ApiManagement/service/{serviceName}/namedValues/{namedValueId}/refreshSecret": { - "post": { - "tags": [ - "NamedValue" - ], - "operationId": "NamedValue_RefreshSecret", - "description": "Refresh the secret of the named value specified by its identifier.", - "x-ms-examples": { - "ApiManagementRefreshNamedValue": { - "$ref": "./examples/ApiManagementRefreshNamedValue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "Request to refresh secret was accepted.", - "headers": { - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "200": { - "description": "Named value was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "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": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimnetworkstatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimnetworkstatus.json deleted file mode 100644 index fae0da9ae1ce..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimnetworkstatus.json +++ /dev/null @@ -1,226 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for getting the network connectivity status of your Azure API Management deployment. When the API Management service is deployed inside a Virtual Network, it needs to have access to other Azure resources it depends on. This also gives details about the DNS Servers visible to Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/networkstatus": { - "get": { - "tags": [ - "NetworkStatus" - ], - "operationId": "NetworkStatus_ListByService", - "description": "Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.", - "x-ms-examples": { - "ApiManagementServiceGetNetworkStatus": { - "$ref": "./examples/ApiManagementServiceGetNetworkStatus.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Gets the list Network status details for all regions in which service is deployed.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkStatusContractByLocation" - }, - "description": "List of Network Status values." - } - }, - "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.ApiManagement/service/{serviceName}/locations/{locationName}/networkstatus": { - "get": { - "tags": [ - "NetworkStatus" - ], - "operationId": "NetworkStatus_ListByLocation", - "description": "Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.", - "x-ms-examples": { - "ApiManagementServiceGetNetworkStatusByLocation": { - "$ref": "./examples/ApiManagementServiceGetNetworkStatusByLocation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/LocationNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Gets the Network status details.", - "schema": { - "$ref": "#/definitions/NetworkStatusContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "ConnectivityStatusContract": { - "properties": { - "name": { - "type": "string", - "description": "The hostname of the resource which the service depends on. This can be the database, storage or any other azure resource on which the service depends upon.", - "minLength": 1 - }, - "status": { - "type": "string", - "enum": [ - "initializing", - "success", - "failure" - ], - "x-ms-enum": { - "name": "ConnectivityStatusType", - "modelAsString": true - }, - "description": "Resource Connectivity Status Type identifier." - }, - "error": { - "type": "string", - "description": "Error details of the connectivity to the resource." - }, - "lastUpdated": { - "type": "string", - "format": "date-time", - "description": "The date when the resource connectivity status was last updated. This status should be updated every 15 minutes. If this status has not been updated, then it means that the service has lost network connectivity to the resource, from inside the Virtual Network.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "lastStatusChange": { - "type": "string", - "format": "date-time", - "description": "The date when the resource connectivity status last Changed from success to failure or vice-versa. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "resourceType": { - "type": "string", - "description": "Resource Type." - }, - "isOptional": { - "type": "boolean", - "description": "Whether this is optional." - } - }, - "required": [ - "name", - "status", - "lastUpdated", - "lastStatusChange", - "resourceType", - "isOptional" - ], - "description": "Details about connectivity to a resource." - }, - "NetworkStatusContractByLocation": { - "properties": { - "location": { - "type": "string", - "description": "Location of service", - "minLength": 1 - }, - "networkStatus": { - "$ref": "#/definitions/NetworkStatusContract", - "description": "Network status in Location" - } - }, - "description": "Network Status in the Location" - }, - "NetworkStatusContract": { - "properties": { - "dnsServers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets the list of DNS servers IPV4 addresses." - }, - "connectivityStatus": { - "type": "array", - "items": { - "$ref": "#/definitions/ConnectivityStatusContract" - }, - "x-ms-identifiers": [ - "name", - "resourceType" - ], - "description": "Gets the list of Connectivity Status to the Resources on which the service depends upon." - } - }, - "required": [ - "dnsServers", - "connectivityStatus" - ], - "description": "Network Status details." - } - }, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimnotifications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimnotifications.json deleted file mode 100644 index ae1f4fdd5e2c..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimnotifications.json +++ /dev/null @@ -1,564 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on who is going to receive notifications associated with your Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/notifications": { - "get": { - "tags": [ - "Notification" - ], - "operationId": "Notification_ListByService", - "description": "Lists a collection of properties defined within a service instance.", - "x-ms-examples": { - "ApiManagementListNotifications": { - "$ref": "./examples/ApiManagementListNotifications.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A Collection of the Notification for the specified API Management service instance.", - "schema": { - "$ref": "./definitions.json#/definitions/NotificationCollection" - } - }, - "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.ApiManagement/service/{serviceName}/notifications/{notificationName}": { - "get": { - "tags": [ - "Notification" - ], - "operationId": "Notification_Get", - "description": "Gets the details of the Notification specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetNotification": { - "$ref": "./examples/ApiManagementGetNotification.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Notification.", - "schema": { - "$ref": "./definitions.json#/definitions/NotificationContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Notification" - ], - "operationId": "Notification_CreateOrUpdate", - "description": "Create or Update API Management publisher notification.", - "x-ms-examples": { - "ApiManagementCreateNotification": { - "$ref": "./examples/ApiManagementCreateNotification.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Notification was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/NotificationContract" - } - }, - "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.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers": { - "get": { - "tags": [ - "NotificationRecipientUser" - ], - "operationId": "NotificationRecipientUser_ListByNotification", - "description": "Gets the list of the Notification Recipient User subscribed to the notification.", - "x-ms-examples": { - "ApiManagementListNotificationRecipientUsers": { - "$ref": "./examples/ApiManagementListNotificationRecipientUsers.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the Recipient User collection for the notification.", - "schema": { - "$ref": "./definitions.json#/definitions/RecipientUserCollection" - } - }, - "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.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers/{userId}": { - "head": { - "tags": [ - "NotificationRecipientUser" - ], - "operationId": "NotificationRecipientUser_CheckEntityExists", - "description": "Determine if the Notification Recipient User is subscribed to the notification.", - "x-ms-examples": { - "ApiManagementHeadNotificationRecipientUser": { - "$ref": "./examples/ApiManagementHeadNotificationRecipientUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "The User is subscribed to receive the notification." - }, - "404": { - "description": "Entity does not exists." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "NotificationRecipientUser" - ], - "operationId": "NotificationRecipientUser_CreateOrUpdate", - "description": "Adds the API Management User to the list of Recipients for the Notification.", - "x-ms-examples": { - "ApiManagementCreateNotificationRecipientUser": { - "$ref": "./examples/ApiManagementCreateNotificationRecipientUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Recipient User was successfully added to the notification list.", - "schema": { - "$ref": "./definitions.json#/definitions/RecipientUserContract" - } - }, - "200": { - "description": "Recipient User is already part of the notification list.", - "schema": { - "$ref": "./definitions.json#/definitions/RecipientUserContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "NotificationRecipientUser" - ], - "operationId": "NotificationRecipientUser_Delete", - "description": "Removes the API Management user from the list of Notification.", - "x-ms-examples": { - "ApiManagementDeleteNotificationRecipientUser": { - "$ref": "./examples/ApiManagementDeleteNotificationRecipientUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Recipient User was successfully removed from the notification list." - }, - "204": { - "description": "Recipient User was successfully removed from the notification list." - }, - "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.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails": { - "get": { - "tags": [ - "NotificationRecipientEmail" - ], - "operationId": "NotificationRecipientEmail_ListByNotification", - "description": "Gets the list of the Notification Recipient Emails subscribed to a notification.", - "x-ms-examples": { - "ApiManagementListNotificationRecipientEmails": { - "$ref": "./examples/ApiManagementListNotificationRecipientEmails.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the Recipient Email collection subscribed to the notification.", - "schema": { - "$ref": "./definitions.json#/definitions/RecipientEmailCollection" - } - }, - "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.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}": { - "head": { - "tags": [ - "NotificationRecipientEmail" - ], - "operationId": "NotificationRecipientEmail_CheckEntityExists", - "description": "Determine if Notification Recipient Email subscribed to the notification.", - "x-ms-examples": { - "ApiManagementHeadNotificationRecipientEmail": { - "$ref": "./examples/ApiManagementHeadNotificationRecipientEmail.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/EmailParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "The Users is subscribed to receive the notification." - }, - "404": { - "description": "The Users is not subscribed to receive the notification." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "NotificationRecipientEmail" - ], - "operationId": "NotificationRecipientEmail_CreateOrUpdate", - "description": "Adds the Email address to the list of Recipients for the Notification.", - "x-ms-examples": { - "ApiManagementCreateNotificationRecipientEmail": { - "$ref": "./examples/ApiManagementCreateNotificationRecipientEmail.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/EmailParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Recipient Email was successfully added to the notification list.", - "schema": { - "$ref": "./definitions.json#/definitions/RecipientEmailContract" - } - }, - "200": { - "description": "Recipient Email is already part of the notification list.", - "schema": { - "$ref": "./definitions.json#/definitions/RecipientEmailContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "NotificationRecipientEmail" - ], - "operationId": "NotificationRecipientEmail_Delete", - "description": "Removes the email from the list of Notification.", - "x-ms-examples": { - "ApiManagementDeleteNotificationRecipientEmail": { - "$ref": "./examples/ApiManagementDeleteNotificationRecipientEmail.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/EmailParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Recipient Email was successfully removed to the notification list." - }, - "204": { - "description": "Recipient Email was successfully removed to the notification list." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimopenidconnectproviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimopenidconnectproviders.json deleted file mode 100644 index d7745c589c3d..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimopenidconnectproviders.json +++ /dev/null @@ -1,427 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on OpenId Connect Provider entity associated with your Azure API Management deployment. API Management allows you to access APIs secured with token from [OpenID Connect Provider ](http://openid.net/connect/) to be accessed from the Developer Console.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/openidConnectProviders": { - "get": { - "tags": [ - "OpenidConnectProvider" - ], - "operationId": "OpenIdConnectProvider_ListByService", - "description": "Lists of all the OpenId Connect Providers.", - "x-ms-examples": { - "ApiManagementListOpenIdConnectProviders": { - "$ref": "./examples/ApiManagementListOpenIdConnectProviders.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists of all the OpenId Connect Providers.", - "schema": { - "$ref": "./definitions.json#/definitions/OpenIdConnectProviderCollection" - } - }, - "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-odata": "./definitions.json#/definitions/OpenidConnectProviderContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}": { - "head": { - "tags": [ - "OpenidConnectProvider" - ], - "operationId": "OpenIdConnectProvider_GetEntityTag", - "description": "Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadOpenIdConnectProvider": { - "$ref": "./examples/ApiManagementHeadOpenIdConnectProvider.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified openidConnectProvider entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "OpenidConnectProvider" - ], - "operationId": "OpenIdConnectProvider_Get", - "description": "Gets specific OpenID Connect Provider without secrets.", - "x-ms-examples": { - "ApiManagementGetOpenIdConnectProvider": { - "$ref": "./examples/ApiManagementGetOpenIdConnectProvider.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified OpenId Connect Provider entity without secrets.", - "schema": { - "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "OpenidConnectProvider" - ], - "operationId": "OpenIdConnectProvider_CreateOrUpdate", - "description": "Creates or updates the OpenID Connect Provider.", - "x-ms-examples": { - "ApiManagementCreateOpenIdConnectProvider": { - "$ref": "./examples/ApiManagementCreateOpenIdConnectProvider.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "OpenIdConnect Provider was successfully created.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" - } - }, - "200": { - "description": "OpenIdConnect Provider was successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "OpenidConnectProvider" - ], - "operationId": "OpenIdConnectProvider_Update", - "description": "Updates the specific OpenID Connect Provider.", - "x-ms-examples": { - "ApiManagementUpdateOpenIdConnectProvider": { - "$ref": "./examples/ApiManagementUpdateOpenIdConnectProvider.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/OpenidConnectProviderUpdateContract" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OpenIdConnect Provider was successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/OpenidConnectProviderContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "OpenidConnectProvider" - ], - "operationId": "OpenIdConnectProvider_Delete", - "description": "Deletes specific OpenID Connect Provider of the API Management service instance.", - "x-ms-examples": { - "ApiManagementDeleteOpenIdConnectProvider": { - "$ref": "./examples/ApiManagementDeleteOpenIdConnectProvider.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OpenId Connect Provider was successfully deleted." - }, - "204": { - "description": "OpenId Connect Provider was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}/listSecrets": { - "post": { - "tags": [ - "OpenidConnectProvider" - ], - "operationId": "OpenIdConnectProvider_ListSecrets", - "description": "Gets the client secret details of the OpenID Connect Provider.", - "x-ms-examples": { - "ApiManagementOpenidConnectProviderListSecrets": { - "$ref": "./examples/ApiManagementOpenidConnectProviderListSecrets.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OpenIdConnectIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified OpenId Connect Provider secrets.", - "schema": { - "$ref": "./definitions.json#/definitions/ClientSecretContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimoutbounddependency.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimoutbounddependency.json deleted file mode 100644 index 0830d6869cbb..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimoutbounddependency.json +++ /dev/null @@ -1,161 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for getting the outbound network dependency of your Azure API Management deployment. When the API Management service is deployed inside a Virtual Network, it needs to have access to other Azure resources it depends on. This also gives details about the DNS Servers visible to Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/outboundNetworkDependenciesEndpoints": { - "get": { - "tags": [ - "OutboundNetworkDependenciesEndpoints" - ], - "operationId": "OutboundNetworkDependenciesEndpoints_ListByService", - "description": "Gets the network endpoints of all outbound dependencies of a ApiManagement service.", - "x-ms-examples": { - "ApiManagementServiceGetOutboundNetworkDependenciesEndpoints": { - "$ref": "./examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OutboundEnvironmentEndpointList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "OutboundEnvironmentEndpointList": { - "description": "Collection of Outbound Environment Endpoints", - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "description": "Collection of resources.", - "type": "array", - "items": { - "$ref": "#/definitions/OutboundEnvironmentEndpoint" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "Link to next page of resources.", - "type": "string", - "readOnly": true - } - } - }, - "OutboundEnvironmentEndpoint": { - "description": "Endpoints accessed for a common purpose that the Api Management Service requires outbound network access to.", - "type": "object", - "properties": { - "category": { - "description": "The type of service accessed by the Api Management Service, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory.", - "type": "string" - }, - "endpoints": { - "description": "The endpoints that the Api Management Service reaches the service at.", - "type": "array", - "items": { - "$ref": "#/definitions/EndpointDependency" - }, - "x-ms-identifiers": [ - "domainName" - ] - } - } - }, - "EndpointDependency": { - "description": "A domain name that a service is reached at.", - "type": "object", - "properties": { - "domainName": { - "description": "The domain name of the dependency.", - "type": "string" - }, - "endpointDetails": { - "description": "The Ports used when connecting to DomainName.", - "type": "array", - "items": { - "$ref": "#/definitions/EndpointDetail" - }, - "x-ms-identifiers": [ - "region", - "port" - ] - } - } - }, - "EndpointDetail": { - "description": "Current TCP connectivity information from the Api Management Service to a single endpoint.", - "type": "object", - "properties": { - "port": { - "format": "int32", - "description": "The port an endpoint is connected to.", - "type": "integer" - }, - "region": { - "description": "The region of the dependency.", - "type": "string" - } - } - } - }, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicies.json deleted file mode 100644 index d7407297f31c..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicies.json +++ /dev/null @@ -1,307 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Global Policies in Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/policies": { - "get": { - "tags": [ - "Policy" - ], - "operationId": "Policy_ListByService", - "description": "Lists all the Global Policy definitions of the Api Management service.", - "x-ms-examples": { - "ApiManagementListPolicies": { - "$ref": "./examples/ApiManagementListPolicies.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Returns an array of Policy Contracts.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyCollection" - } - }, - "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.ApiManagement/service/{serviceName}/policies/{policyId}": { - "head": { - "tags": [ - "Policy" - ], - "operationId": "Policy_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Global policy definition in the Api Management service.", - "x-ms-examples": { - "ApiManagementHeadPolicy": { - "$ref": "./examples/ApiManagementHeadPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Policy" - ], - "operationId": "Policy_Get", - "description": "Get the Global policy definition of the Api Management service.", - "x-ms-examples": { - "ApiManagementGetPolicy": { - "$ref": "./examples/ApiManagementGetPolicy.json" - }, - "ApiManagementGetPolicyFormat": { - "$ref": "./examples/ApiManagementGetPolicyFormat.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Get the Global policy definition of the Api Management service.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Policy" - ], - "operationId": "Policy_CreateOrUpdate", - "description": "Creates or updates the global policy configuration of the Api Management service.", - "x-ms-examples": { - "ApiManagementCreatePolicy": { - "$ref": "./examples/ApiManagementCreatePolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "description": "The policy contents to apply." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Global policy configuration was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Global policy configuration of the Api Management service was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Policy" - ], - "operationId": "Policy_Delete", - "description": "Deletes the global policy configuration of the Api Management Service.", - "x-ms-examples": { - "ApiManagementDeletePolicy": { - "$ref": "./examples/ApiManagementDeletePolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Policy was successfully removed" - }, - "204": { - "description": "Policy successfully removed by previous request or does not exist" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicydescriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicydescriptions.json deleted file mode 100644 index 9d110c0deecc..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicydescriptions.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing retrieving a collection of policy snippets available in Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/policyDescriptions": { - "get": { - "tags": [ - "PolicyDescription" - ], - "operationId": "PolicyDescription_ListByService", - "description": "Lists all policy descriptions.", - "x-ms-examples": { - "ApiManagementListPolicyDescriptions": { - "$ref": "./examples/ApiManagementListPolicyDescriptions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "scope", - "in": "query", - "required": false, - "type": "string", - "description": "Policy scope.", - "enum": [ - "Tenant", - "Product", - "Api", - "Operation", - "All" - ], - "x-ms-enum": { - "name": "PolicyScopeContract", - "modelAsString": false - } - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Returns an array of policy descriptions.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyDescriptionCollection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicyfragments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicyfragments.json deleted file mode 100644 index 92566896caf9..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicyfragments.json +++ /dev/null @@ -1,398 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "REST API for performing operations on policy fragments in an Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/policyFragments": { - "get": { - "tags": [ - "PolicyFragment" - ], - "operationId": "PolicyFragment_ListByService", - "description": "Gets all policy fragments.", - "x-ms-examples": { - "ApiManagementListPolicyFragments": { - "$ref": "./examples/ApiManagementListPolicyFragments.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter, orderBy | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| value | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "name": "$orderby", - "in": "query", - "required": false, - "type": "string", - "description": "OData order by query option." - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - } - ], - "responses": { - "200": { - "description": "Successfully returned an array of policy fragments.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyFragmentCollection" - } - }, - "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.ApiManagement/service/{serviceName}/policyFragments/{id}": { - "head": { - "tags": [ - "PolicyFragment" - ], - "operationId": "PolicyFragment_GetEntityTag", - "description": "Gets the entity state (Etag) version of a policy fragment.", - "x-ms-examples": { - "ApiManagementHeadPolicyFragment": { - "$ref": "./examples/ApiManagementHeadPolicyFragment.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The specified policy fragment exists and the current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "PolicyFragment" - ], - "operationId": "PolicyFragment_Get", - "description": "Gets a policy fragment.", - "x-ms-examples": { - "ApiManagementGetPolicyFragment": { - "$ref": "./examples/ApiManagementGetPolicyFragment.json" - }, - "ApiManagementGetPolicyFragmentFormat": { - "$ref": "./examples/ApiManagementGetPolicyFragmentFormat.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyFragmentContentFormat" - } - ], - "responses": { - "200": { - "description": "Successfully returned a policy fragment.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyFragmentContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "PolicyFragment" - ], - "operationId": "PolicyFragment_CreateOrUpdate", - "description": "Creates or updates a policy fragment.", - "x-ms-examples": { - "ApiManagementCreatePolicy": { - "$ref": "./examples/ApiManagementCreatePolicyFragment.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PolicyFragmentContract" - }, - "description": "The policy fragment contents to apply." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The policy fragment was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyFragmentContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "201": { - "description": "The policy fragment was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyFragmentContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "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" - } - }, - "delete": { - "tags": [ - "PolicyFragment" - ], - "operationId": "PolicyFragment_Delete", - "description": "Deletes a policy fragment.", - "x-ms-examples": { - "ApiManagementDeletePolicy": { - "$ref": "./examples/ApiManagementDeletePolicyFragment.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The policy fragment was successfully removed." - }, - "204": { - "description": "The policy fragment successfully removed by previous request or does not exist." - }, - "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.ApiManagement/service/{serviceName}/policyFragments/{id}/listReferences": { - "post": { - "tags": [ - "PolicyFragment" - ], - "operationId": "PolicyFragment_ListReferences", - "description": "Lists policy resources that reference the policy fragment.", - "x-ms-examples": { - "ApiManagementListPolicyFragmentReferences": { - "$ref": "./examples/ApiManagementListPolicyFragmentReferences.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - } - ], - "responses": { - "200": { - "description": "Successfully returned an array of references to policy resources that include the policy fragment in their definitions.", - "schema": { - "$ref": "./definitions.json#/definitions/ResourceCollection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicyrestrictions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicyrestrictions.json deleted file mode 100644 index ecd8e2a83db9..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicyrestrictions.json +++ /dev/null @@ -1,362 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "REST API for performing policy restrictions on any created/updated policies in an Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/policyRestrictions": { - "get": { - "tags": [ - "PolicyRestrictions" - ], - "operationId": "PolicyRestriction_ListByService", - "description": "Gets all policy restrictions of API Management services.", - "x-ms-examples": { - "ApiManagementListPolicyRestrictions": { - "$ref": "./examples/ApiManagementListPolicyRestrictions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Returns an array of Policy Restrictions.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyRestrictionCollection" - } - }, - "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.ApiManagement/service/{serviceName}/policyRestrictions/{policyRestrictionId}": { - "head": { - "tags": [ - "PolicyRestriction" - ], - "operationId": "PolicyRestriction_GetEntityTag", - "description": "Gets the entity state (Etag) version of the policy restriction in the Api Management service.", - "x-ms-examples": { - "ApiManagementHeadPolicyRestriction": { - "$ref": "./examples/ApiManagementHeadPolicyRestriction.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyRestrictionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "PolicyRestriction" - ], - "operationId": "PolicyRestriction_Get", - "description": "Get the policy restriction of the Api Management service.", - "x-ms-examples": { - "ApiManagementGetPolicyRestriction": { - "$ref": "./examples/ApiManagementGetPolicyRestriction.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyRestrictionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Get the policy restriction of the Api Management service.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyRestrictionContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "PolicyRestriction" - ], - "operationId": "PolicyRestriction_CreateOrUpdate", - "description": "Creates or updates the policy restriction configuration of the Api Management service.", - "x-ms-examples": { - "ApiManagementCreatePolicyRestriction": { - "$ref": "./examples/ApiManagementCreatePolicyRestriction.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyRestrictionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PolicyRestrictionContract" - }, - "description": "The policy restriction to apply." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "201": { - "description": "Policy restriction configuration was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyRestrictionContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Policy restriction configuration of the Api Management service was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyRestrictionContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "PolicyRestriction" - ], - "operationId": "PolicyRestriction_Update", - "description": "Updates the policy restriction configuration of the Api Management service.", - "x-ms-examples": { - "ApiManagementUpdatePolicyRestriction": { - "$ref": "./examples/ApiManagementUpdatePolicyRestriction.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyRestrictionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PolicyRestrictionUpdateContract" - }, - "description": "The policy restriction to apply." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Policy restriction configuration of the Api Management service was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyRestrictionContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "PolicyRestriction" - ], - "operationId": "PolicyRestriction_Delete", - "description": "Deletes the policy restriction configuration of the Api Management Service.", - "x-ms-examples": { - "ApiManagementDeletePolicyRestriction": { - "$ref": "./examples/ApiManagementDeletePolicyRestriction.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyRestrictionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Policy restriction was successfully removed." - }, - "204": { - "description": "Policy restriction was successfully removed by previous request or does not exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicyrestrictionsvalidation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicyrestrictionsvalidation.json deleted file mode 100644 index 8a5a7ce852f7..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimpolicyrestrictionsvalidation.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "REST API for performing policy restrictions on any created/updated policies in an Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/validatePolicies": { - "post": { - "tags": [ - "PolicyRestrictionsValidations" - ], - "operationId": "PolicyRestrictionValidations_ByService", - "description": "Validate all policies of API Management services.", - "x-ms-examples": { - "ApiManagementListPolicyRestrictions": { - "$ref": "./examples/ApiManagementValidatePolicies.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "Accepted", - "headers": { - "location": { - "description": "location of the header.", - "type": "string" - } - } - }, - "200": { - "description": "Policy Restrictions are successfully validated.", - "schema": { - "$ref": "./definitions.json#/definitions/OperationResultContract" - } - }, - "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": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimportalconfigs.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimportalconfigs.json deleted file mode 100644 index 843947442b6d..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimportalconfigs.json +++ /dev/null @@ -1,291 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use this REST API to perform operations on the developer portal configuration.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/portalconfigs": { - "get": { - "tags": [ - "PortalConfig" - ], - "operationId": "PortalConfig_ListByService", - "description": "Lists the developer portal configurations.", - "x-ms-examples": { - "ApiManagementListPortalConfig": { - "$ref": "./examples/ApiManagementListPortalConfig.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The developer portal configuration.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalConfigCollection" - } - }, - "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.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}": { - "head": { - "tags": [ - "PortalConfig" - ], - "operationId": "PortalConfig_GetEntityTag", - "description": "Gets the entity state (Etag) version of the developer portal configuration.", - "x-ms-examples": { - "ApiManagementHeadPortalConfig": { - "$ref": "./examples/ApiManagementHeadPortalConfig.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PortalConfigIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "PortalConfig" - ], - "operationId": "PortalConfig_Get", - "description": "Get the developer portal configuration.", - "x-ms-examples": { - "ApiManagementPortalConfig": { - "$ref": "./examples/ApiManagementPortalConfig.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PortalConfigIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The developer portal configuration.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalConfigContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "PortalConfig" - ], - "operationId": "PortalConfig_Update", - "description": "Update the developer portal configuration.", - "x-ms-examples": { - "ApiManagementUpdatePortalConfig": { - "$ref": "./examples/ApiManagementUpdatePortalConfig.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PortalConfigIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PortalConfigContract" - }, - "description": "Update the developer portal configuration." - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalConfigContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "PortalConfig" - ], - "operationId": "PortalConfig_CreateOrUpdate", - "description": "Create or update the developer portal configuration.", - "x-ms-examples": { - "ApiManagementCreatePortalConfig": { - "$ref": "./examples/ApiManagementCreatePortalConfig.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PortalConfigIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PortalConfigContract" - }, - "description": "Update the developer portal configuration." - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalConfigContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimportalrevisions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimportalrevisions.json deleted file mode 100644 index 466ab89ae5ca..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimportalrevisions.json +++ /dev/null @@ -1,341 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations in Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/portalRevisions": { - "get": { - "tags": [ - "PortalRevision" - ], - "operationId": "PortalRevision_ListByService", - "description": "Lists developer portal's revisions.", - "x-ms-examples": { - "ApiManagementListPortalRevisions": { - "$ref": "./examples/ApiManagementListPortalRevisions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n\r\n|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|isCurrent | eq, ne | |\n" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists portal's revisions.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalRevisionCollection" - } - }, - "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.ApiManagement/service/{serviceName}/portalRevisions/{portalRevisionId}": { - "head": { - "tags": [ - "PortalRevision" - ], - "operationId": "PortalRevision_GetEntityTag", - "description": "Gets the developer portal revision specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadPortalRevision": { - "$ref": "./examples/ApiManagementHeadPortalRevision.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The specified portal revision entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "PortalRevision" - ], - "operationId": "PortalRevision_Get", - "description": "Gets the developer portal's revision specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetPortalRevision": { - "$ref": "./examples/ApiManagementGetPortalRevision.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the specified portal's revision.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalRevisionContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "PortalRevision" - ], - "operationId": "PortalRevision_CreateOrUpdate", - "description": "Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible.", - "x-ms-examples": { - "ApiManagementCreatePortalRevision": { - "$ref": "./examples/ApiManagementCreatePortalRevision.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PortalRevisionContract" - } - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "The developer portal revision was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalRevisionContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "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" - } - }, - "patch": { - "tags": [ - "PortalRevision" - ], - "operationId": "PortalRevision_Update", - "description": "Updates the description of specified portal revision or makes it current.", - "x-ms-examples": { - "ApiManagementUpdatePortalRevision": { - "$ref": "./examples/ApiManagementUpdatePortalRevision.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PortalRevisionContract" - } - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "Request to update developer portal revision was accepted.", - "headers": { - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "200": { - "description": "Developer portal revision was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalRevisionContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "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": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimportalsettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimportalsettings.json deleted file mode 100644 index b1be7046ae64..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimportalsettings.json +++ /dev/null @@ -1,713 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on PortalSettings entity associated with your Azure API Management deployment. Using this entity you can manage settings for a Developer Portal.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/portalsettings": { - "get": { - "deprecated": true, - "tags": [ - "PortalSettings" - ], - "operationId": "PortalSettings_ListByService", - "description": "Lists a collection of portalsettings defined within a service instance..", - "x-ms-examples": { - "ApiManagementListPortalSettings": { - "$ref": "./examples/ApiManagementListPortalSettings.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Portal Settings entities.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalSettingsCollection" - } - }, - "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.ApiManagement/service/{serviceName}/portalsettings/signin": { - "head": { - "deprecated": true, - "tags": [ - "SignInSettings" - ], - "operationId": "SignInSettings_GetEntityTag", - "description": "Gets the entity state (Etag) version of the SignInSettings.", - "x-ms-examples": { - "ApiManagementHeadSignInSettings": { - "$ref": "./examples/ApiManagementHeadSignInSettings.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "deprecated": true, - "tags": [ - "SignInSettings" - ], - "operationId": "SignInSettings_Get", - "description": "Get Sign In Settings for the Portal", - "x-ms-examples": { - "ApiManagementPortalSettingsGetSignIn": { - "$ref": "./examples/ApiManagementPortalSettingsGetSignIn.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Sign-In settings.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalSigninSettings" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "deprecated": true, - "tags": [ - "SignInSettings" - ], - "operationId": "SignInSettings_Update", - "description": "Update Sign-In settings.", - "x-ms-examples": { - "ApiManagementPortalSettingsUpdateSignIn": { - "$ref": "./examples/ApiManagementPortalSettingsUpdateSignIn.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PortalSigninSettings" - }, - "description": "Update Sign-In settings." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "Sign-In settings was updated successfully." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "deprecated": true, - "tags": [ - "SignInSettings" - ], - "operationId": "SignInSettings_CreateOrUpdate", - "description": "Create or Update Sign-In settings.", - "x-ms-examples": { - "ApiManagementPortalSettingsUpdateSignIn": { - "$ref": "./examples/ApiManagementPortalSettingsPutSignIn.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PortalSigninSettings" - }, - "description": "Create or update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Sign-In settings was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalSigninSettings" - } - }, - "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.ApiManagement/service/{serviceName}/portalsettings/signup": { - "head": { - "deprecated": true, - "tags": [ - "SignUpSettings" - ], - "operationId": "SignUpSettings_GetEntityTag", - "description": "Gets the entity state (Etag) version of the SignUpSettings.", - "x-ms-examples": { - "ApiManagementHeadSignUpSettings": { - "$ref": "./examples/ApiManagementHeadSignUpSettings.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "deprecated": true, - "tags": [ - "SignUpSettings" - ], - "operationId": "SignUpSettings_Get", - "description": "Get Sign Up Settings for the Portal", - "x-ms-examples": { - "ApiManagementPortalSettingsGetSignUp": { - "$ref": "./examples/ApiManagementPortalSettingsGetSignUp.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Sign-Up settings.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalSignupSettings" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "deprecated": true, - "tags": [ - "SignUpSettings" - ], - "operationId": "SignUpSettings_Update", - "description": "Update Sign-Up settings.", - "x-ms-examples": { - "ApiManagementPortalSettingsUpdateSignUp": { - "$ref": "./examples/ApiManagementPortalSettingsUpdateSignUp.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PortalSignupSettings" - }, - "description": "Update Sign-Up settings." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "Sign-Up settings was updated successfully." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "deprecated": true, - "tags": [ - "SignUpSettings" - ], - "operationId": "SignUpSettings_CreateOrUpdate", - "description": "Create or Update Sign-Up settings.", - "x-ms-examples": { - "ApiManagementPortalSettingsUpdateSignUp": { - "$ref": "./examples/ApiManagementPortalSettingsPutSignUp.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PortalSignupSettings" - }, - "description": "Create or update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Sign-Up settings was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalSignupSettings" - } - }, - "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.ApiManagement/service/{serviceName}/portalsettings/delegation": { - "head": { - "deprecated": true, - "tags": [ - "DelegationSettings" - ], - "operationId": "DelegationSettings_GetEntityTag", - "description": "Gets the entity state (Etag) version of the DelegationSettings.", - "x-ms-examples": { - "ApiManagementHeadDelegationSettings": { - "$ref": "./examples/ApiManagementHeadDelegationSettings.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "deprecated": true, - "tags": [ - "DelegationSettings" - ], - "operationId": "DelegationSettings_Get", - "description": "Get Delegation Settings for the Portal.", - "x-ms-examples": { - "ApiManagementPortalSettingsGetDelegation": { - "$ref": "./examples/ApiManagementPortalSettingsGetDelegation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Delegation settings.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalDelegationSettings" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "deprecated": true, - "tags": [ - "DelegationSettings" - ], - "operationId": "DelegationSettings_Update", - "description": "Update Delegation settings.", - "x-ms-examples": { - "ApiManagementPortalSettingsUpdateDelegation": { - "$ref": "./examples/ApiManagementPortalSettingsUpdateDelegation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PortalDelegationSettings" - }, - "description": "Update Delegation settings." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "Delegation settings was updated successfully." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "deprecated": true, - "tags": [ - "DelegationSettings" - ], - "operationId": "DelegationSettings_CreateOrUpdate", - "description": "Create or Update Delegation settings.", - "x-ms-examples": { - "ApiManagementPortalSettingsUpdateDelegation": { - "$ref": "./examples/ApiManagementPortalSettingsPutDelegation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PortalDelegationSettings" - }, - "description": "Create or update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Delegation settings was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalDelegationSettings" - } - }, - "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.ApiManagement/service/{serviceName}/portalsettings/delegation/listSecrets": { - "post": { - "deprecated": true, - "tags": [ - "DelegationSettings" - ], - "operationId": "DelegationSettings_ListSecrets", - "description": "Gets the secret validation key of the DelegationSettings.", - "x-ms-examples": { - "ApiManagementListSecretsPortalSettings": { - "$ref": "./examples/ApiManagementListSecretsPortalSettingsValidationKey.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the validation key.", - "schema": { - "$ref": "./definitions.json#/definitions/PortalSettingValidationKeyContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimprivatelink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimprivatelink.json deleted file mode 100644 index ed2cc5cfef63..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimprivatelink.json +++ /dev/null @@ -1,347 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Private Endpoint Connection in Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/privateEndpointConnections": { - "get": { - "tags": [ - "PrivateEndpointConnections" - ], - "operationId": "PrivateEndpointConnection_ListByService", - "description": "Lists all private endpoint connections of the API Management service instance.", - "x-ms-examples": { - "ApiManagementListPrivateEndpointConnections": { - "$ref": "./examples/ApiManagementListPrivateEndpointConnections.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/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": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}": { - "get": { - "tags": [ - "PrivateEndpointConnections" - ], - "operationId": "PrivateEndpointConnection_GetByName", - "description": "Gets the details of the Private Endpoint Connection specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetPrivateEndpointConnection": { - "$ref": "./examples/ApiManagementGetPrivateEndpointConnection.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "Name of the private endpoint connection.", - "required": true, - "type": "string" - }, - { - "$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": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "PrivateEndpointConnections" - ], - "operationId": "PrivateEndpointConnection_CreateOrUpdate", - "description": "Creates a new Private Endpoint Connection or updates an existing one.", - "x-ms-examples": { - "ApiManagementApproveOrRejectPrivateEndpointConnection": { - "$ref": "./examples/ApiManagementApproveOrRejectPrivateEndpointConnection.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "Name of the private endpoint connection.", - "required": true, - "type": "string" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "privateEndpointConnectionRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PrivateEndpointConnectionRequest" - } - } - ], - "responses": { - "202": { - "description": "Request to approve or reject private endpoint connection. Location header contains the URL where the status of the long running operation can be checked.", - "headers": { - "location": { - "description": "Location header", - "type": "string" - } - } - }, - "200": { - "description": "Private Endpoint Connection Request was completed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v2/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-long-running-operation": true - }, - "delete": { - "tags": [ - "PrivateEndpointConnections" - ], - "operationId": "PrivateEndpointConnection_Delete", - "description": "Deletes the specified Private Endpoint Connection.", - "x-ms-examples": { - "ApiManagementDeletePrivateEndpointConnection": { - "$ref": "./examples/ApiManagementDeletePrivateEndpointConnection.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "Name of the private endpoint connection.", - "required": true, - "type": "string" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The Private Endpoint Connection was successfully deleted." - }, - "202": { - "description": "Request to delete API was accepted. Location header contains the URL where the status of the long running operation can be checked.", - "headers": { - "location": { - "description": "Location header", - "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 - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateLinkResources": { - "get": { - "tags": [ - "PrivateEndpointConnections" - ], - "description": "Gets the private link resources", - "operationId": "PrivateEndpointConnection_ListPrivateLinkResources", - "x-ms-examples": { - "ApiManagementListPrivateLinkGroupResources": { - "$ref": "./examples/ApiManagementListPrivateLinkGroupResources.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResourceListResult" - } - }, - "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.ApiManagement/service/{serviceName}/privateLinkResources/{privateLinkSubResourceName}": { - "get": { - "tags": [ - "PrivateEndpointConnections" - ], - "description": "Gets the private link resources", - "operationId": "PrivateEndpointConnection_GetPrivateLinkResource", - "x-ms-examples": { - "ApiManagementGetPrivateLinkGroupResource": { - "$ref": "./examples/ApiManagementGetPrivateLinkGroupResource.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "privateLinkSubResourceName", - "in": "path", - "description": "Name of the private link resource.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimproducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimproducts.json deleted file mode 100644 index 4834f153a1bc..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimproducts.json +++ /dev/null @@ -1,2202 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Product entity associated with your Azure API Management deployment. The Product entity represents a product in API Management. Products include one or more APIs and their associated terms of use. Once a product is published, developers can subscribe to the product and begin to use the product’s APIs.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/products": { - "get": { - "tags": [ - "Product" - ], - "operationId": "Product_ListByService", - "description": "Lists a collection of products in the specified service instance.", - "x-ms-examples": { - "ApiManagementListProducts": { - "$ref": "./examples/ApiManagementListProducts.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| groups | expand | | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "expandGroups", - "in": "query", - "required": false, - "type": "boolean", - "description": "When set to true, the response contains an array of groups that have visibility to the product. The default is false." - }, - { - "name": "tags", - "in": "query", - "required": false, - "type": "string", - "description": "Products which are part of a specific tag." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A Collection of the Product entities for the specified API Management service instance.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ProductContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}": { - "head": { - "tags": [ - "Product" - ], - "operationId": "Product_GetEntityTag", - "description": "Gets the entity state (Etag) version of the product specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadProduct": { - "$ref": "./examples/ApiManagementHeadProduct.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified Product entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Product" - ], - "operationId": "Product_Get", - "description": "Gets the details of the product specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetProduct": { - "$ref": "./examples/ApiManagementGetProduct.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Product entity.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Product" - ], - "operationId": "Product_CreateOrUpdate", - "description": "Creates or Updates a product.", - "x-ms-examples": { - "ApiManagementCreateProduct": { - "$ref": "./examples/ApiManagementCreateProduct.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ProductContract" - }, - "description": "Create or update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Product was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Product was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Product" - ], - "operationId": "Product_Update", - "description": "Update existing product details.", - "x-ms-examples": { - "ApiManagementUpdateProduct": { - "$ref": "./examples/ApiManagementUpdateProduct.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ProductUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Product was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Product" - ], - "operationId": "Product_Delete", - "description": "Delete product.", - "x-ms-examples": { - "ApiManagementDeleteProduct": { - "$ref": "./examples/ApiManagementDeleteProduct.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "name": "deleteSubscriptions", - "in": "query", - "required": false, - "type": "boolean", - "description": "Delete existing subscriptions associated with the product or not." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Product was successfully removed." - }, - "204": { - "description": "Product was successfully removed by previous request or does not exist." - }, - "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.ApiManagement/service/{serviceName}/products/{productId}/apis": { - "get": { - "tags": [ - "ProductApi" - ], - "operationId": "ProductApi_ListByProduct", - "description": "Lists a collection of the APIs associated with a product.", - "x-ms-examples": { - "ApiManagementListProductApis": { - "$ref": "./examples/ApiManagementListProductApis.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains a collection of Api entities in the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ApiContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}": { - "head": { - "tags": [ - "ProductApi" - ], - "operationId": "ProductApi_CheckEntityExists", - "description": "Checks that API entity specified by identifier is associated with the Product entity.", - "x-ms-examples": { - "ApiManagementHeadProductApi": { - "$ref": "./examples/ApiManagementHeadProductApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "Entity exists" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ProductApi" - ], - "operationId": "ProductApi_CreateOrUpdate", - "description": "Adds an API to the specified product.", - "x-ms-examples": { - "ApiManagementCreateProductApi": { - "$ref": "./examples/ApiManagementCreateProductApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "The API was successfully added to the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiContract" - } - }, - "200": { - "description": "The specified API is already added to the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ProductApi" - ], - "operationId": "ProductApi_Delete", - "description": "Deletes the specified API from the specified product.", - "x-ms-examples": { - "ApiManagementDeleteProductApi": { - "$ref": "./examples/ApiManagementDeleteProductApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "API was successfully removed from product" - }, - "204": { - "description": "API successfully removed by previous request or does not exist in product" - }, - "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.ApiManagement/service/{serviceName}/products/{productId}/groups": { - "get": { - "tags": [ - "ProductGroup" - ], - "operationId": "ProductGroup_ListByProduct", - "description": "Lists the collection of developer groups associated with the specified product.", - "x-ms-examples": { - "ApiManagementListProductGroups": { - "$ref": "./examples/ApiManagementListProductGroups.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | |
| displayName | filter | eq, ne | |
| description | filter | eq, ne | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Group entities.", - "schema": { - "$ref": "./definitions.json#/definitions/GroupCollection" - } - }, - "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-odata": "./definitions.json#/definitions/GroupContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}": { - "head": { - "tags": [ - "ProductGroup" - ], - "operationId": "ProductGroup_CheckEntityExists", - "description": "Checks that Group entity specified by identifier is associated with the Product entity.", - "x-ms-examples": { - "ApiManagementHeadProductGroup": { - "$ref": "./examples/ApiManagementHeadProductGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "The Group is associated with the Product." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ProductGroup" - ], - "operationId": "ProductGroup_CreateOrUpdate", - "description": "Adds the association between the specified developer group with the specified product.", - "x-ms-examples": { - "ApiManagementCreateProductGroup": { - "$ref": "./examples/ApiManagementCreateProductGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "The group was successfully associated with the product.", - "schema": { - "$ref": "./definitions.json#/definitions/GroupContract" - } - }, - "200": { - "description": "The specified group is already associated with the product.", - "schema": { - "$ref": "./definitions.json#/definitions/GroupContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ProductGroup" - ], - "operationId": "ProductGroup_Delete", - "description": "Deletes the association between the specified group and product.", - "x-ms-examples": { - "ApiManagementDeleteProductGroup": { - "$ref": "./examples/ApiManagementDeleteProductGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The group was successfully disassociated with the product." - }, - "204": { - "description": "The group was successfully disassociated with the product." - }, - "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.ApiManagement/service/{serviceName}/products/{productId}/subscriptions": { - "get": { - "tags": [ - "ProductSubscription" - ], - "operationId": "ProductSubscriptions_List", - "description": "Lists the collection of subscriptions to the specified product.", - "x-ms-examples": { - "ApiManagementListProductSubscriptions": { - "$ref": "./examples/ApiManagementListProductSubscriptions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of subscription entities.", - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionCollection" - } - }, - "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-odata": "./definitions.json#/definitions/SubscriptionContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies": { - "get": { - "tags": [ - "ProductPolicy" - ], - "operationId": "ProductPolicy_ListByProduct", - "description": "Get the policy configuration at the Product level.", - "x-ms-examples": { - "ApiManagementListProductPolicies": { - "$ref": "./examples/ApiManagementListProductPolicies.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Product Policy information.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyCollection" - } - }, - "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.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}": { - "head": { - "tags": [ - "ProductPolicy" - ], - "operationId": "ProductPolicy_GetEntityTag", - "description": "Get the ETag of the policy configuration at the Product level.", - "x-ms-examples": { - "ApiManagementHeadProductPolicy": { - "$ref": "./examples/ApiManagementHeadProductPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Product Policy Etag information.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ProductPolicy" - ], - "operationId": "ProductPolicy_Get", - "description": "Get the policy configuration at the Product level.", - "x-ms-examples": { - "ApiManagementGetProductPolicy": { - "$ref": "./examples/ApiManagementGetProductPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Product Policy information.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ProductPolicy" - ], - "operationId": "ProductPolicy_CreateOrUpdate", - "description": "Creates or updates policy configuration for the Product.", - "x-ms-examples": { - "ApiManagementCreateProductPolicy": { - "$ref": "./examples/ApiManagementCreateProductPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "description": "The policy contents to apply." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Product policy configuration was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Product policy configuration of the tenant was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ProductPolicy" - ], - "operationId": "ProductPolicy_Delete", - "description": "Deletes the policy configuration at the Product.", - "x-ms-examples": { - "ApiManagementDeleteProductPolicy": { - "$ref": "./examples/ApiManagementDeleteProductPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the policy configuration at the Product level." - }, - "204": { - "description": "Successfully deleted the policy configuration at the Product level." - }, - "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.ApiManagement/service/{serviceName}/products/{productId}/tags": { - "get": { - "tags": [ - "ProductTag" - ], - "operationId": "Tag_ListByProduct", - "description": "Lists all Tags associated with the Product.", - "x-ms-examples": { - "ApiManagementListProductTags": { - "$ref": "./examples/ApiManagementListProductTags.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a collection of tags associated with the Product entity.", - "schema": { - "$ref": "./definitions.json#/definitions/TagCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}": { - "head": { - "tags": [ - "ProductTag" - ], - "operationId": "Tag_GetEntityStateByProduct", - "description": "Gets the entity state version of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadProductTag": { - "$ref": "./examples/ApiManagementHeadProductTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Empty response body, ETag header entity state version.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ProductTag" - ], - "operationId": "Tag_GetByProduct", - "description": "Get tag associated with the Product.", - "x-ms-examples": { - "ApiManagementGetProductTag": { - "$ref": "./examples/ApiManagementGetProductTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the details of the tag specified by its identifier.", - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ProductTag" - ], - "operationId": "Tag_AssignToProduct", - "description": "Assign tag to the Product.", - "x-ms-examples": { - "ApiManagementCreateProductTag": { - "$ref": "./examples/ApiManagementCreateProductTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Tag was assigned to the Product.", - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - } - }, - "200": { - "description": "Tag is already assigned to the Product.", - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ProductTag" - ], - "operationId": "Tag_DetachFromProduct", - "description": "Detach the tag from the Product.", - "x-ms-examples": { - "ApiManagementDeleteProductTag": { - "$ref": "./examples/ApiManagementDeleteProductTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully detached the tag from the Product." - }, - "204": { - "description": "Successfully detached the tag from the Product." - }, - "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.ApiManagement/service/{serviceName}/products/{productId}/wikis/default": { - "head": { - "tags": [ - "ProductWiki" - ], - "operationId": "ProductWiki_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Wiki for a Product specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadProductWiki": { - "$ref": "./examples/ApiManagementHeadProductWiki.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ProductWiki" - ], - "operationId": "ProductWiki_Get", - "description": "Gets the details of the Wiki for a Product specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetProductWiki": { - "$ref": "./examples/ApiManagementGetProductWiki.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Wiki entity.", - "schema": { - "$ref": "./definitions.json#/definitions/WikiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ProductWiki" - ], - "operationId": "ProductWiki_CreateOrUpdate", - "description": "Creates a new Wiki for a Product or updates an existing one.", - "x-ms-examples": { - "ApiManagementCreateProductWiki": { - "$ref": "./examples/ApiManagementCreateProductWiki.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/WikiContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Wiki was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/WikiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Wiki was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/WikiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "ProductWiki" - ], - "operationId": "ProductWiki_Update", - "description": "Updates the details of the Wiki for a Product specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateProductWiki": { - "$ref": "./examples/ApiManagementUpdateProductWiki.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/WikiUpdateContract" - }, - "description": "Wiki Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Wiki was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/WikiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ProductWiki" - ], - "operationId": "ProductWiki_Delete", - "description": "Deletes the specified Wiki from a Product.", - "x-ms-examples": { - "ApiManagementDeleteProductWiki": { - "$ref": "./examples/ApiManagementDeleteProductWiki.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Wiki successfully removed" - }, - "204": { - "description": "Wiki successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/products/{productId}/wikis": { - "get": { - "tags": [ - "ProductWiki" - ], - "operationId": "ProductWikis_list", - "description": "Gets the details of the Wiki for a Product specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetApiWiki": { - "$ref": "./examples/ApiManagementListProductWikis.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Wiki entity.", - "schema": { - "$ref": "./definitions.json#/definitions/WikiCollection" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "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-odata": "./definitions.json#/definitions/WikiContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apiLinks": { - "get": { - "tags": [ - "ProductApiLink" - ], - "operationId": "ProductApiLink_ListByProduct", - "description": "Lists a collection of the API links associated with a product.", - "x-ms-examples": { - "ApiManagementListProductApiLinks": { - "$ref": "./examples/ApiManagementListProductApiLinks.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains a collection of API link entities in the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductApiLinkCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ProductApiLinkContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apiLinks/{apiLinkId}": { - "get": { - "tags": [ - "ProductApiLink" - ], - "operationId": "ProductApiLink_Get", - "description": "Gets the API link for the product.", - "x-ms-examples": { - "ApiManagementGetProductApiLink": { - "$ref": "./examples/ApiManagementGetProductApiLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductApiLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified API link entity.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductApiLinkContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ProductApiLink" - ], - "operationId": "ProductApiLink_CreateOrUpdate", - "description": "Adds an API to the specified product via link.", - "x-ms-examples": { - "ApiManagementCreateProductApiLink": { - "$ref": "./examples/ApiManagementCreateProductApiLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductApiLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ProductApiLinkContract" - }, - "description": "Create or update parameters." - } - ], - "responses": { - "200": { - "description": "The specified API is already added to the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductApiLinkContract" - } - }, - "201": { - "description": "The API was successfully added to the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductApiLinkContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ProductApiLink" - ], - "operationId": "ProductApiLink_Delete", - "description": "Deletes the specified API from the specified product.", - "x-ms-examples": { - "ApiManagementDeleteProductApiLink": { - "$ref": "./examples/ApiManagementDeleteProductApiLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductApiLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "API was successfully removed from product" - }, - "204": { - "description": "API successfully removed by previous request or does not exist in product" - }, - "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.ApiManagement/service/{serviceName}/products/{productId}/groupLinks": { - "get": { - "tags": [ - "ProductGroupLink" - ], - "operationId": "ProductGroupLink_ListByProduct", - "description": "Lists a collection of the group links associated with a product.", - "x-ms-examples": { - "ApiManagementListProductGroupLinks": { - "$ref": "./examples/ApiManagementListProductGroupLinks.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| groupId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains a collection of group link entities in the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductGroupLinkCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ProductGroupLinkContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groupLinks/{groupLinkId}": { - "get": { - "tags": [ - "ProductGroupLink" - ], - "operationId": "ProductGroupLink_Get", - "description": "Gets the group link for the product.", - "x-ms-examples": { - "ApiManagementGetProductGroupLink": { - "$ref": "./examples/ApiManagementGetProductGroupLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductGroupLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified group link entity.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ProductGroupLink" - ], - "operationId": "ProductGroupLink_CreateOrUpdate", - "description": "Adds a group to the specified product via link.", - "x-ms-examples": { - "ApiManagementCreateProductGroupLink": { - "$ref": "./examples/ApiManagementCreateProductGroupLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductGroupLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" - }, - "description": "Create or update parameters." - } - ], - "responses": { - "200": { - "description": "The specified group is already added to the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" - } - }, - "201": { - "description": "The group was successfully added to the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ProductGroupLink" - ], - "operationId": "ProductGroupLink_Delete", - "description": "Deletes the specified group from the specified product.", - "x-ms-examples": { - "ApiManagementDeleteProductGroupLink": { - "$ref": "./examples/ApiManagementDeleteProductGroupLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductGroupLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Group was successfully removed from product" - }, - "204": { - "description": "Group successfully removed by previous request or does not exist in product" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimproductsByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimproductsByTags.json deleted file mode 100644 index 058f97cc69eb..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimproductsByTags.json +++ /dev/null @@ -1,106 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations to retrieve Products by Tags in Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/productsByTags": { - "get": { - "tags": [ - "ProductsByTag" - ], - "operationId": "Product_ListByTags", - "description": "Lists a collection of products associated with tags.", - "x-ms-examples": { - "ApiManagementListProductsByTags": { - "$ref": "./examples/ApiManagementListProductsByTags.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "includeNotTaggedProducts", - "in": "query", - "required": false, - "type": "boolean", - "description": "Include not tagged Products." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of TagResource entities.", - "schema": { - "$ref": "./definitions.json#/definitions/TagResourceCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagResourceContract" - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimquotas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimquotas.json deleted file mode 100644 index 484e8030155d..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimquotas.json +++ /dev/null @@ -1,248 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Quota entity associated with your Azure API Management deployment. To configure call rate limit and quota policies refer to [how to configure call rate limit and quota](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies).", - "version": "2024-10-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.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}": { - "get": { - "tags": [ - "QuotaByCounterKeys" - ], - "operationId": "QuotaByCounterKeys_ListByService", - "description": "Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies", - "description": "Document describing how to configure the quota policies." - }, - "x-ms-examples": { - "ApiManagementGetQuotaCounterKeys": { - "$ref": "./examples/ApiManagementGetQuotaCounterKeys.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/QuotaCounterKeyParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of the quota counter values.", - "schema": { - "$ref": "./definitions.json#/definitions/QuotaCounterCollection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "QuotaByCounterKeys" - ], - "operationId": "QuotaByCounterKeys_Update", - "description": "Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values.", - "x-ms-examples": { - "ApiManagementUpdateQuotaCounterKey": { - "$ref": "./examples/ApiManagementUpdateQuotaCounterKey.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/QuotaCounterKeyParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/QuotaCounterValueUpdateContract" - }, - "description": "The value of the quota counter to be applied to all quota counter periods." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Updated Quota Counter Values.", - "schema": { - "$ref": "./definitions.json#/definitions/QuotaCounterCollection" - } - }, - "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.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/periods/{quotaPeriodKey}": { - "get": { - "tags": [ - "QuotaByPeriodKeys" - ], - "operationId": "QuotaByPeriodKeys_Get", - "description": "Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies", - "description": "Document describing how to configure the quota policies." - }, - "x-ms-examples": { - "ApiManagementGetQuotaCounterKeysByQuotaPeriod": { - "$ref": "./examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/QuotaCounterKeyParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/QuotaPeriodKeyParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the Quota counter details for the specified period.", - "schema": { - "$ref": "./definitions.json#/definitions/QuotaCounterContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "QuotaByPeriodKeys" - ], - "operationId": "QuotaByPeriodKeys_Update", - "description": "Updates an existing quota counter value in the specified service instance.", - "x-ms-examples": { - "ApiManagementUpdateQuotaCounterKeyByQuotaPeriod": { - "$ref": "./examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/QuotaCounterKeyParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/QuotaPeriodKeyParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/QuotaCounterValueUpdateContract" - }, - "description": "The value of the Quota counter to be applied on the specified period." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the Quota counter details for the specified period.", - "schema": { - "$ref": "./definitions.json#/definitions/QuotaCounterContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimregions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimregions.json deleted file mode 100644 index eb83a9b1a56c..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimregions.json +++ /dev/null @@ -1,85 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations in Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/regions": { - "get": { - "tags": [ - "Region" - ], - "operationId": "Region_ListByService", - "description": "Lists all azure regions in which the service exists.", - "x-ms-examples": { - "ApiManagementListRegions": { - "$ref": "./examples/ApiManagementListRegions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists of Regions in which the service is deployed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/RegionListResult" - } - }, - "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": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimreports.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimreports.json deleted file mode 100644 index 453243ed24d6..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimreports.json +++ /dev/null @@ -1,562 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs to get the analytics reports associated with your Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/reports/byApi": { - "get": { - "tags": [ - "Reports" - ], - "operationId": "Reports_ListByApi", - "description": "Lists report records by API.", - "x-ms-examples": { - "ApiManagementGetReportsByApi": { - "$ref": "./examples/ApiManagementGetReportsByApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": true, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "$orderby", - "in": "query", - "required": false, - "type": "string", - "description": "OData order by query option." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Report record.", - "schema": { - "$ref": "./definitions.json#/definitions/ReportCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ReportRecordContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byUser": { - "get": { - "tags": [ - "Reports" - ], - "operationId": "Reports_ListByUser", - "description": "Lists report records by User.", - "x-ms-examples": { - "ApiManagementGetReportsByUser": { - "$ref": "./examples/ApiManagementGetReportsByUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": true, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| userId | select, filter | eq | |
| apiRegion | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "$orderby", - "in": "query", - "required": false, - "type": "string", - "description": "OData order by query option." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Report record.", - "schema": { - "$ref": "./definitions.json#/definitions/ReportCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ReportRecordContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byOperation": { - "get": { - "tags": [ - "Reports" - ], - "operationId": "Reports_ListByOperation", - "description": "Lists report records by API Operations.", - "x-ms-examples": { - "ApiManagementGetReportsByOperation": { - "$ref": "./examples/ApiManagementGetReportsByOperation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": true, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | select, filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "$orderby", - "in": "query", - "required": false, - "type": "string", - "description": "OData order by query option." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Report record.", - "schema": { - "$ref": "./definitions.json#/definitions/ReportCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ReportRecordContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byProduct": { - "get": { - "tags": [ - "Reports" - ], - "operationId": "Reports_ListByProduct", - "description": "Lists report records by Product.", - "x-ms-examples": { - "ApiManagementGetReportsByProduct": { - "$ref": "./examples/ApiManagementGetReportsByProduct.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": true, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | select, filter | eq | |
| subscriptionId | filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "$orderby", - "in": "query", - "required": false, - "type": "string", - "description": "OData order by query option." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Report record.", - "schema": { - "$ref": "./definitions.json#/definitions/ReportCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ReportRecordContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byGeo": { - "get": { - "tags": [ - "Reports" - ], - "operationId": "Reports_ListByGeo", - "description": "Lists report records by geography.", - "x-ms-examples": { - "ApiManagementGetReportsByGeo": { - "$ref": "./examples/ApiManagementGetReportsByGeo.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": true, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| country | select | | |
| region | select | | |
| zip | select | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select | | |
| callCountBlocked | select | | |
| callCountFailed | select | | |
| callCountOther | select | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Report record.", - "schema": { - "$ref": "./definitions.json#/definitions/ReportCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ReportRecordContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/bySubscription": { - "get": { - "tags": [ - "Reports" - ], - "operationId": "Reports_ListBySubscription", - "description": "Lists report records by subscription.", - "x-ms-examples": { - "ApiManagementGetReportsBySubscription": { - "$ref": "./examples/ApiManagementGetReportsBySubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": true, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | select, filter | eq | |
| productId | select, filter | eq | |
| subscriptionId | select, filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "$orderby", - "in": "query", - "required": false, - "type": "string", - "description": "OData order by query option." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Report record.", - "schema": { - "$ref": "./definitions.json#/definitions/ReportCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ReportRecordContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byTime": { - "get": { - "tags": [ - "Reports" - ], - "operationId": "Reports_ListByTime", - "description": "Lists report records by Time.", - "x-ms-examples": { - "ApiManagementGetReportsByTime": { - "$ref": "./examples/ApiManagementGetReportsByTime.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": true, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter, select | ge, le | |
| interval | select | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select | | |
| callCountBlocked | select | | |
| callCountFailed | select | | |
| callCountOther | select | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "$orderby", - "in": "query", - "required": false, - "type": "string", - "description": "OData order by query option." - }, - { - "name": "interval", - "in": "query", - "required": true, - "type": "string", - "format": "duration", - "description": "By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Report record.", - "schema": { - "$ref": "./definitions.json#/definitions/ReportCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ReportRecordContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byRequest": { - "get": { - "tags": [ - "Reports" - ], - "operationId": "Reports_ListByRequest", - "description": "Lists report records by Request.", - "x-ms-examples": { - "ApiManagementGetReportsByRequest": { - "$ref": "./examples/ApiManagementGetReportsByRequest.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": true, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| productId | filter | eq | |
| userId | filter | eq | |
| apiRegion | filter | eq | |
| subscriptionId | filter | eq | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Report record.", - "schema": { - "$ref": "./definitions.json#/definitions/RequestReportCollection" - } - }, - "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 - }, - "x-ms-odata": "./definitions.json#/definitions/RequestReportRecordContract" - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimschema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimschema.json deleted file mode 100644 index 6353f2063ce5..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimschema.json +++ /dev/null @@ -1,344 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Schema entity in Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/schemas": { - "get": { - "tags": [ - "Schema" - ], - "operationId": "GlobalSchema_ListByService", - "description": "Lists a collection of schemas registered with service instance.", - "x-ms-examples": { - "ApiManagementListSchemas": { - "$ref": "./examples/ApiManagementListGlobalSchemas.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Schema entities.", - "schema": { - "$ref": "./definitions.json#/definitions/GlobalSchemaCollection" - } - }, - "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-odata": "./definitions.json#/definitions/GlobalSchemaContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId}": { - "head": { - "tags": [ - "Schema" - ], - "operationId": "GlobalSchema_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Schema specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApi": { - "$ref": "./examples/ApiManagementHeadGlobalSchema.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified Schema entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Schema" - ], - "operationId": "GlobalSchema_Get", - "description": "Gets the details of the Schema specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetSchema1": { - "$ref": "./examples/ApiManagementGetGlobalSchema1.json" - }, - "ApiManagementGetSchema2": { - "$ref": "./examples/ApiManagementGetGlobalSchema2.json" - } - }, - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Schema entity.", - "schema": { - "$ref": "./definitions.json#/definitions/GlobalSchemaContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Schema" - ], - "operationId": "GlobalSchema_CreateOrUpdate", - "description": "Creates new or updates existing specified Schema of the API Management service instance.", - "x-ms-examples": { - "ApiManagementCreateSchema1": { - "$ref": "./examples/ApiManagementCreateGlobalSchema1.json" - }, - "ApiManagementCreateSchema2": { - "$ref": "./examples/ApiManagementCreateGlobalSchema2.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/GlobalSchemaContract" - }, - "description": "Create or update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "The new Schema was successfully added.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/GlobalSchemaContract" - } - }, - "200": { - "description": "The Schema details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/GlobalSchemaContract" - } - }, - "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" - } - }, - "delete": { - "tags": [ - "Schema" - ], - "operationId": "GlobalSchema_Delete", - "description": "Deletes specific Schema.", - "x-ms-examples": { - "ApiManagementDeleteSchema": { - "$ref": "./examples/ApiManagementDeleteGlobalSchema.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The Schema was successfully deleted." - }, - "204": { - "description": "The Schema was successfully deleted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimsettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimsettings.json deleted file mode 100644 index 8cd65db35e4d..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimsettings.json +++ /dev/null @@ -1,146 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on settings entity associated with your Azure API Management deployment. Using this entity you can manage properties and configuration that apply to the entire API Management service instance.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/settings": { - "get": { - "deprecated": true, - "tags": [ - "TenantSettings" - ], - "operationId": "TenantSettings_ListByService", - "description": "Public settings.", - "x-ms-examples": { - "ApiManagementListTenantSettings": { - "$ref": "./examples/ApiManagementListTenantSettings.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "Not used" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of TenantSettings entities.", - "schema": { - "$ref": "./definitions.json#/definitions/TenantSettingsCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TenantSettingsContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings/{settingsType}": { - "get": { - "deprecated": true, - "tags": [ - "TenantSettings" - ], - "operationId": "TenantSettings_Get", - "description": "Get tenant settings.", - "x-ms-examples": { - "ApiManagementGetTenantSettings": { - "$ref": "./examples/ApiManagementGetTenantSettings.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SettingsParameter" - } - ], - "responses": { - "200": { - "description": "Tenant Settings.", - "schema": { - "$ref": "./definitions.json#/definitions/TenantSettingsContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimskus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimskus.json deleted file mode 100644 index 7433c1f835e2..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimskus.json +++ /dev/null @@ -1,391 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "SKUs available for Microsoft.ApiManagement", - "version": "2024-10-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}/providers/Microsoft.ApiManagement/skus": { - "get": { - "tags": [ - "Skus" - ], - "operationId": "ApiManagementSkus_List", - "description": "Gets the list of Microsoft.ApiManagement SKUs available for your Subscription.", - "x-ms-examples": { - "Lists all available Resource SKUs": { - "$ref": "./examples/ApiManagementListSku.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": "OK", - "schema": { - "$ref": "#/definitions/ApiManagementSkusResult" - } - }, - "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": { - "ApiManagementSkuCapacity": { - "properties": { - "minimum": { - "type": "integer", - "readOnly": true, - "format": "int32", - "description": "The minimum capacity." - }, - "maximum": { - "type": "integer", - "readOnly": true, - "format": "int32", - "description": "The maximum capacity that can be set." - }, - "default": { - "type": "integer", - "readOnly": true, - "format": "int32", - "description": "The default capacity." - }, - "scaleType": { - "type": "string", - "readOnly": true, - "description": "The scale type applicable to the sku.", - "enum": [ - "Automatic", - "Manual", - "None" - ], - "x-ms-enum": { - "name": "ApiManagementSkuCapacityScaleType", - "modelAsString": false - } - } - }, - "description": "Describes scaling information of a SKU." - }, - "ApiManagementSkuCosts": { - "properties": { - "meterID": { - "type": "string", - "readOnly": true, - "description": "Used for querying price from commerce." - }, - "quantity": { - "type": "integer", - "readOnly": true, - "format": "int64", - "description": "The multiplier is needed to extend the base metered cost." - }, - "extendedUnit": { - "type": "string", - "readOnly": true, - "description": "An invariant to show the extended unit." - } - }, - "description": "Describes metadata for retrieving price info." - }, - "ApiManagementSkuCapabilities": { - "properties": { - "name": { - "type": "string", - "readOnly": true, - "description": "An invariant to describe the feature." - }, - "value": { - "type": "string", - "readOnly": true, - "description": "An invariant if the feature is measured by quantity." - } - }, - "description": "Describes The SKU capabilities object." - }, - "ApiManagementSkuZoneDetails": { - "properties": { - "name": { - "type": "array", - "readOnly": true, - "items": { - "type": "string" - }, - "description": "The set of zones that the SKU is available in with the specified capabilities." - }, - "capabilities": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ApiManagementSkuCapabilities" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "A list of capabilities that are available for the SKU in the specified list of zones." - } - }, - "description": "Describes The zonal capabilities of a SKU." - }, - "ApiManagementSkuRestrictions": { - "properties": { - "type": { - "type": "string", - "readOnly": true, - "description": "The type of restrictions.", - "enum": [ - "Location", - "Zone" - ], - "x-ms-enum": { - "name": "ApiManagementSkuRestrictionsType", - "modelAsString": false - } - }, - "values": { - "type": "array", - "readOnly": true, - "items": { - "type": "string" - }, - "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted." - }, - "restrictionInfo": { - "$ref": "#/definitions/ApiManagementSkuRestrictionInfo", - "readOnly": true, - "description": "The information about the restriction where the SKU cannot be used." - }, - "reasonCode": { - "type": "string", - "readOnly": true, - "description": "The reason for restriction.", - "enum": [ - "QuotaId", - "NotAvailableForSubscription" - ], - "x-ms-enum": { - "name": "ApiManagementSkuRestrictionsReasonCode", - "modelAsString": false - } - } - }, - "description": "Describes scaling information of a SKU." - }, - "ApiManagementSku": { - "properties": { - "resourceType": { - "readOnly": true, - "type": "string", - "description": "The type of resource the SKU applies to." - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The name of SKU." - }, - "tier": { - "readOnly": true, - "type": "string", - "description": "Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic**" - }, - "size": { - "readOnly": true, - "type": "string", - "description": "The Size of the SKU." - }, - "family": { - "readOnly": true, - "type": "string", - "description": "The Family of this particular SKU." - }, - "kind": { - "readOnly": true, - "type": "string", - "description": "The Kind of resources that are supported in this SKU." - }, - "capacity": { - "$ref": "#/definitions/ApiManagementSkuCapacity", - "readOnly": true, - "description": "Specifies the number of virtual machines in the scale set." - }, - "locations": { - "type": "array", - "readOnly": true, - "items": { - "type": "string" - }, - "description": "The set of locations that the SKU is available." - }, - "locationInfo": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ApiManagementSkuLocationInfo" - }, - "x-ms-identifiers": [ - "location" - ], - "description": "A list of locations and availability zones in those locations where the SKU is available." - }, - "apiVersions": { - "type": "array", - "readOnly": true, - "items": { - "type": "string" - }, - "description": "The api versions that support this SKU." - }, - "costs": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ApiManagementSkuCosts" - }, - "x-ms-identifiers": [ - "meterID" - ], - "description": "Metadata for retrieving price info." - }, - "capabilities": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ApiManagementSkuCapabilities" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "A name value pair to describe the capability." - }, - "restrictions": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ApiManagementSkuRestrictions" - }, - "x-ms-identifiers": [], - "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." - } - }, - "description": "Describes an available ApiManagement SKU." - }, - "ApiManagementSkuLocationInfo": { - "properties": { - "location": { - "readOnly": true, - "type": "string", - "description": "Location of the SKU" - }, - "zones": { - "readOnly": true, - "type": "array", - "items": { - "type": "string" - }, - "description": "List of availability zones where the SKU is supported." - }, - "zoneDetails": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/ApiManagementSkuZoneDetails" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "Details of capabilities available to a SKU in specific zones." - } - } - }, - "ApiManagementSkuRestrictionInfo": { - "properties": { - "locations": { - "readOnly": true, - "type": "array", - "items": { - "type": "string" - }, - "description": "Locations where the SKU is restricted" - }, - "zones": { - "readOnly": true, - "type": "array", - "items": { - "type": "string" - }, - "description": "List of availability zones where the SKU is restricted." - } - } - }, - "ApiManagementSkusResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiManagementSku" - }, - "x-ms-identifiers": [ - "name", - "resourceType" - ], - "description": "The list of skus available for the subscription." - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The URI to fetch the next page of Resource Skus. Call ListNext() with this URI to fetch the next page of Resource Skus" - } - }, - "required": [ - "value" - ], - "description": "The List Resource Skus operation response." - } - }, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimsubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimsubscriptions.json deleted file mode 100644 index 41c1b78cbc33..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimsubscriptions.json +++ /dev/null @@ -1,523 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Subscription entity associated with your Azure API Management deployment. The Subscription entity represents the association between a user and a product in API Management. Products contain one or more APIs, and once a product is published, developers can subscribe to the product and begin to use the product’s APIs.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/subscriptions": { - "get": { - "tags": [ - "Subscription" - ], - "operationId": "Subscription_List", - "description": "Lists all subscriptions of the API Management service instance.", - "x-ms-examples": { - "ApiManagementListSubscriptions": { - "$ref": "./examples/ApiManagementListSubscriptions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A collection of the Subscription entities for the specified API Management service instance.", - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionCollection" - } - }, - "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-odata": "./definitions.json#/definitions/SubscriptionContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}": { - "head": { - "tags": [ - "Subscription" - ], - "operationId": "Subscription_GetEntityTag", - "description": "Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadSubscription": { - "$ref": "./examples/ApiManagementHeadSubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified apimanagement subscription entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Subscription" - ], - "operationId": "Subscription_Get", - "description": "Gets the specified Subscription entity.", - "x-ms-examples": { - "ApiManagementGetSubscription": { - "$ref": "./examples/ApiManagementGetSubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Subscription entity.", - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Subscription" - ], - "operationId": "Subscription_CreateOrUpdate", - "description": "Creates or updates the subscription of specified user to the specified product.", - "x-ms-examples": { - "ApiManagementCreateSubscription": { - "$ref": "./examples/ApiManagementCreateSubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionCreateParameters" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/NotifySubscriptionStateChangeParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AppTypeParameter" - } - ], - "responses": { - "201": { - "description": "The user was successfully subscribed to the product.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionContract" - } - }, - "200": { - "description": "The user already subscribed to the product.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Subscription" - ], - "operationId": "Subscription_Update", - "description": "Updates the details of a subscription specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateSubscription": { - "$ref": "./examples/ApiManagementUpdateSubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/NotifySubscriptionStateChangeParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AppTypeParameter" - } - ], - "responses": { - "200": { - "description": "The subscription details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Subscription" - ], - "operationId": "Subscription_Delete", - "description": "Deletes the specified subscription.", - "x-ms-examples": { - "ApiManagementDeleteSubscription": { - "$ref": "./examples/ApiManagementDeleteSubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The subscription details were successfully deleted." - }, - "204": { - "description": "The subscription details were successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/subscriptions/{sid}/regeneratePrimaryKey": { - "post": { - "tags": [ - "Subscription" - ], - "operationId": "Subscription_RegeneratePrimaryKey", - "description": "Regenerates primary key of existing subscription of the API Management service instance.", - "x-ms-examples": { - "ApiManagementSubscriptionRegeneratePrimaryKey": { - "$ref": "./examples/ApiManagementSubscriptionRegeneratePrimaryKey.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "The primary key was successfully regenerated." - }, - "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.ApiManagement/service/{serviceName}/subscriptions/{sid}/regenerateSecondaryKey": { - "post": { - "tags": [ - "Subscription" - ], - "operationId": "Subscription_RegenerateSecondaryKey", - "description": "Regenerates secondary key of existing subscription of the API Management service instance.", - "x-ms-examples": { - "ApiManagementSubscriptionRegenerateSecondaryKey": { - "$ref": "./examples/ApiManagementSubscriptionRegenerateSecondaryKey.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "The secondary key was successfully regenerated." - }, - "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.ApiManagement/service/{serviceName}/subscriptions/{sid}/listSecrets": { - "post": { - "tags": [ - "Subscription" - ], - "operationId": "Subscription_ListSecrets", - "description": "Gets the specified Subscription keys.", - "x-ms-examples": { - "ApiManagementSubscriptionListSecrets": { - "$ref": "./examples/ApiManagementSubscriptionListSecrets.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains subscription keys.", - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionKeysContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimtagresources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimtagresources.json deleted file mode 100644 index b1649f40ef56..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimtagresources.json +++ /dev/null @@ -1,99 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for querying APIs. Operations and Products by tags in your Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/tagResources": { - "get": { - "tags": [ - "TagResource" - ], - "operationId": "TagResource_ListByService", - "description": "Lists a collection of resources associated with tags.", - "x-ms-examples": { - "ApiManagementListTagResources": { - "$ref": "./examples/ApiManagementListTagResources.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| aid | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| isCurrent | filter | eq | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of TagResource entities.", - "schema": { - "$ref": "./definitions.json#/definitions/TagResourceCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagResourceContract" - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimtags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimtags.json deleted file mode 100644 index 412d8fcf4cbd..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimtags.json +++ /dev/null @@ -1,1052 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Tag entity in your Azure API Management deployment. Tags can be assigned to APIs, Operations and Products.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/tags": { - "get": { - "tags": [ - "Tag" - ], - "operationId": "Tag_ListByService", - "description": "Lists a collection of tags defined within a service instance.", - "x-ms-examples": { - "ApiManagementListTags": { - "$ref": "./examples/ApiManagementListTags.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "scope", - "in": "query", - "required": false, - "type": "string", - "description": "Scope like 'apis', 'products' or 'apis/{apiId}" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Tag entities.", - "schema": { - "$ref": "./definitions.json#/definitions/TagCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}": { - "head": { - "tags": [ - "Tag" - ], - "operationId": "Tag_GetEntityState", - "description": "Gets the entity state version of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadTag": { - "$ref": "./examples/ApiManagementHeadTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Empty response body, ETag header entity state version.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Tag" - ], - "operationId": "Tag_Get", - "description": "Gets the details of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetTag": { - "$ref": "./examples/ApiManagementGetTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Tag entity.", - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Tag" - ], - "operationId": "Tag_CreateOrUpdate", - "description": "Creates a tag.", - "x-ms-examples": { - "ApiManagementCreateTag": { - "$ref": "./examples/ApiManagementCreateTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/TagCreateUpdateParameters" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Tag was created successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - } - }, - "200": { - "description": "Tag already exists.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Tag" - ], - "operationId": "Tag_Update", - "description": "Updates the details of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateTag": { - "$ref": "./examples/ApiManagementUpdateTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/TagCreateUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The tag details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Tag" - ], - "operationId": "Tag_Delete", - "description": "Deletes specific tag of the API Management service instance.", - "x-ms-examples": { - "ApiManagementDeleteTag": { - "$ref": "./examples/ApiManagementDeleteTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Tag successfully removed" - }, - "204": { - "description": "Tag successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/tags/{tagId}/apiLinks": { - "get": { - "tags": [ - "TagApiLink" - ], - "operationId": "TagApiLink_ListByProduct", - "description": "Lists a collection of the API links associated with a tag.", - "x-ms-examples": { - "ApiManagementListTagApiLinks": { - "$ref": "./examples/ApiManagementListTagApiLinks.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains a collection of API link entities associated with a tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagApiLinkCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagApiLinkContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}/apiLinks/{apiLinkId}": { - "get": { - "tags": [ - "TagApiLink" - ], - "operationId": "TagApiLink_Get", - "description": "Gets the API link for the tag.", - "x-ms-examples": { - "ApiManagementGetTagApiLink": { - "$ref": "./examples/ApiManagementGetTagApiLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagApiLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified API link entity.", - "schema": { - "$ref": "./definitions.json#/definitions/TagApiLinkContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "TagApiLink" - ], - "operationId": "TagApiLink_CreateOrUpdate", - "description": "Adds an API to the specified tag via link.", - "x-ms-examples": { - "ApiManagementCreateTagApiLink": { - "$ref": "./examples/ApiManagementCreateTagApiLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagApiLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/TagApiLinkContract" - }, - "description": "Create or update parameters." - } - ], - "responses": { - "200": { - "description": "The specified API is already added to the tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagApiLinkContract" - } - }, - "201": { - "description": "The API was successfully added to the tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagApiLinkContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "TagApiLink" - ], - "operationId": "TagApiLink_Delete", - "description": "Deletes the specified API from the specified tag.", - "x-ms-examples": { - "ApiManagementDeleteTagApiLink": { - "$ref": "./examples/ApiManagementDeleteTagApiLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagApiLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "API was successfully removed from tag" - }, - "204": { - "description": "API successfully removed by previous request or does not exist in tag" - }, - "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.ApiManagement/service/{serviceName}/tags/{tagId}/operationLinks": { - "get": { - "tags": [ - "TagOperationLink" - ], - "operationId": "TagOperationLink_ListByProduct", - "description": "Lists a collection of the operation links associated with a tag.", - "x-ms-examples": { - "ApiManagementListTagOperationLinks": { - "$ref": "./examples/ApiManagementListTagOperationLinks.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| operationId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains a collection of operation link entities associated with a tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagOperationLinkCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagOperationLinkContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}/operationLinks/{operationLinkId}": { - "get": { - "tags": [ - "TagOperationLink" - ], - "operationId": "TagOperationLink_Get", - "description": "Gets the operation link for the tag.", - "x-ms-examples": { - "ApiManagementGetTagOperationLink": { - "$ref": "./examples/ApiManagementGetTagOperationLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagOperationLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified operation link entity.", - "schema": { - "$ref": "./definitions.json#/definitions/TagOperationLinkContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "TagOperationLink" - ], - "operationId": "TagOperationLink_CreateOrUpdate", - "description": "Adds an operation to the specified tag via link.", - "x-ms-examples": { - "ApiManagementCreateTagOperationLink": { - "$ref": "./examples/ApiManagementCreateTagOperationLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagOperationLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/TagOperationLinkContract" - }, - "description": "Create or update parameters." - } - ], - "responses": { - "200": { - "description": "The specified operation is already added to the tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagOperationLinkContract" - } - }, - "201": { - "description": "The operation was successfully added to the tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagOperationLinkContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "TagOperationLink" - ], - "operationId": "TagOperationLink_Delete", - "description": "Deletes the specified operation from the specified tag.", - "x-ms-examples": { - "ApiManagementDeleteTagOperationLink": { - "$ref": "./examples/ApiManagementDeleteTagOperationLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagOperationLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation was successfully removed from tag" - }, - "204": { - "description": "Operation successfully removed by previous request or does not exist in tag" - }, - "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.ApiManagement/service/{serviceName}/tags/{tagId}/productLinks": { - "get": { - "tags": [ - "TagProductLink" - ], - "operationId": "TagProductLink_ListByProduct", - "description": "Lists a collection of the product links associated with a tag.", - "x-ms-examples": { - "ApiManagementListTagProductLinks": { - "$ref": "./examples/ApiManagementListTagProductLinks.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains a collection of product link entities associated with a tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagProductLinkCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagProductLinkContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}/productLinks/{productLinkId}": { - "get": { - "tags": [ - "TagProductLink" - ], - "operationId": "TagProductLink_Get", - "description": "Gets the product link for the tag.", - "x-ms-examples": { - "ApiManagementGetTagProductLink": { - "$ref": "./examples/ApiManagementGetTagProductLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagProductLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified product link entity.", - "schema": { - "$ref": "./definitions.json#/definitions/TagProductLinkContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "TagProductLink" - ], - "operationId": "TagProductLink_CreateOrUpdate", - "description": "Adds a product to the specified tag via link.", - "x-ms-examples": { - "ApiManagementCreateTagProductLink": { - "$ref": "./examples/ApiManagementCreateTagProductLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagProductLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/TagProductLinkContract" - }, - "description": "Create or update parameters." - } - ], - "responses": { - "200": { - "description": "The specified product is already added to the tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagProductLinkContract" - } - }, - "201": { - "description": "The product was successfully added to the tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagProductLinkContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "TagProductLink" - ], - "operationId": "TagProductLink_Delete", - "description": "Deletes the specified product from the specified tag.", - "x-ms-examples": { - "ApiManagementDeleteTagProductLink": { - "$ref": "./examples/ApiManagementDeleteTagProductLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagProductLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Product was successfully removed from tag" - }, - "204": { - "description": "Product successfully removed by previous request or does not exist in tag" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimtenant.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimtenant.json deleted file mode 100644 index b16215a46246..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimtenant.json +++ /dev/null @@ -1,785 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on tenant entity associated with your Azure API Management deployment. Using this entity you can manage properties and configuration that apply to the entire API Management service instance.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/tenant": { - "get": { - "tags": [ - "TenantAccess" - ], - "operationId": "TenantAccess_ListByService", - "description": "Returns list of access infos - for Git and Management endpoints.", - "x-ms-examples": { - "ApiManagementListTenantAccess": { - "$ref": "./examples/ApiManagementListTenantAccess.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "Not used" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of TenantAccessInfo entities.", - "schema": { - "$ref": "./definitions.json#/definitions/AccessInformationCollection" - } - }, - "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-odata": "./definitions.json#/definitions/AccessInformationContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}": { - "head": { - "tags": [ - "TenantAccess" - ], - "operationId": "TenantAccess_GetEntityTag", - "description": "Tenant access metadata", - "x-ms-examples": { - "ApiManagementHeadTenantAccess": { - "$ref": "./examples/ApiManagementHeadTenantAccess.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AccessParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "TenantAccess" - ], - "operationId": "TenantAccess_Get", - "description": "Get tenant access information details without secrets.", - "x-ms-examples": { - "ApiManagementGetTenantAccess": { - "$ref": "./examples/ApiManagementGetTenantAccess.json" - }, - "ApiManagementGetTenantGitAccess": { - "$ref": "./examples/ApiManagementGetTenantGitAccess.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AccessParameter" - } - ], - "responses": { - "200": { - "description": "Tenant Access information.", - "schema": { - "$ref": "./definitions.json#/definitions/AccessInformationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "TenantAccess" - ], - "operationId": "TenantAccess_Create", - "description": "Update tenant access information details.", - "x-ms-examples": { - "ApiManagementCreateTenantAccess": { - "$ref": "./examples/ApiManagementCreateTenantAccess.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/AccessInformationCreateParameters" - }, - "description": "Parameters supplied to retrieve the Tenant Access Information." - }, - { - "$ref": "./apimanagement.json#/parameters/AccessParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Tenant Access information was updated successfully.", - "schema": { - "$ref": "./definitions.json#/definitions/AccessInformationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "TenantAccess" - ], - "operationId": "TenantAccess_Update", - "description": "Update tenant access information details.", - "x-ms-examples": { - "ApiManagementUpdateTenantAccess": { - "$ref": "./examples/ApiManagementUpdateTenantAccess.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/AccessInformationUpdateParameters" - }, - "description": "Parameters supplied to retrieve the Tenant Access Information." - }, - { - "$ref": "./apimanagement.json#/parameters/AccessParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Tenant Access information was updated successfully.", - "schema": { - "$ref": "./definitions.json#/definitions/AccessInformationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "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.ApiManagement/service/{serviceName}/tenant/{accessName}/regeneratePrimaryKey": { - "post": { - "tags": [ - "TenantAccess" - ], - "operationId": "TenantAccess_RegeneratePrimaryKey", - "description": "Regenerate primary access key", - "x-ms-examples": { - "ApiManagementTenantAccessRegenerateKey": { - "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AccessParameter" - } - ], - "responses": { - "204": { - "description": "The primary key was successfully regenerated." - }, - "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.ApiManagement/service/{serviceName}/tenant/{accessName}/regenerateSecondaryKey": { - "post": { - "tags": [ - "TenantAccess" - ], - "operationId": "TenantAccess_RegenerateSecondaryKey", - "description": "Regenerate secondary access key", - "x-ms-examples": { - "ApiManagementTenantAccessRegenerateKey": { - "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AccessParameter" - } - ], - "responses": { - "204": { - "description": "The secondary key was successfully regenerated." - }, - "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.ApiManagement/service/{serviceName}/tenant/{accessName}/listSecrets": { - "post": { - "tags": [ - "TenantAccess" - ], - "operationId": "TenantAccess_ListSecrets", - "description": "Get tenant access information details.", - "x-ms-examples": { - "ApiManagementListSecretsTenantAccess": { - "$ref": "./examples/ApiManagementListSecretsTenantAccess.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AccessParameter" - } - ], - "responses": { - "200": { - "description": "Tenant Access information.", - "schema": { - "$ref": "./definitions.json#/definitions/AccessInformationSecretsContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "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.ApiManagement/service/{serviceName}/tenant/{accessName}/git/regeneratePrimaryKey": { - "post": { - "tags": [ - "TenantAccessGit" - ], - "operationId": "TenantAccessGit_RegeneratePrimaryKey", - "description": "Regenerate primary access key for GIT.", - "x-ms-examples": { - "ApiManagementTenantAccessRegenerateKey": { - "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AccessParameter" - } - ], - "responses": { - "204": { - "description": "The primary key was successfully regenerated." - }, - "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.ApiManagement/service/{serviceName}/tenant/{accessName}/git/regenerateSecondaryKey": { - "post": { - "tags": [ - "TenantAccessGit" - ], - "operationId": "TenantAccessGit_RegenerateSecondaryKey", - "description": "Regenerate secondary access key for GIT.", - "x-ms-examples": { - "ApiManagementTenantAccessRegenerateKey": { - "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AccessParameter" - } - ], - "responses": { - "204": { - "description": "The secondary key was successfully regenerated." - }, - "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.ApiManagement/service/{serviceName}/tenant/{configurationName}/deploy": { - "post": { - "tags": [ - "TenantConfiguration" - ], - "operationId": "TenantConfiguration_Deploy", - "description": "This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.", - "externalDocs": { - "description": "To deploy any service configuration changes to the API Management service instance", - "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-configuration-repository-git/#to-deploy-any-service-configuration-changes-to-the-api-management-service-instance" - }, - "x-ms-examples": { - "ApiManagementTenantConfigurationDeploy": { - "$ref": "./examples/ApiManagementTenantConfigurationDeploy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/DeployConfigurationParameters" - }, - "description": "Deploy Configuration parameters." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ConfigurationParameter" - } - ], - "responses": { - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked.", - "headers": { - "location": { - "type": "string" - } - } - }, - "200": { - "description": "Result of applying changes from Git branch to database.", - "schema": { - "$ref": "./definitions.json#/definitions/OperationResultContract" - } - }, - "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.ApiManagement/service/{serviceName}/tenant/{configurationName}/save": { - "post": { - "tags": [ - "TenantConfiguration" - ], - "operationId": "TenantConfiguration_Save", - "description": "This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.", - "externalDocs": { - "description": "To save the service configuration to the Git repository", - "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-configuration-repository-git/#to-save-the-service-configuration-to-the-git-repository" - }, - "x-ms-examples": { - "ApiManagementTenantConfigurationSave": { - "$ref": "./examples/ApiManagementTenantConfigurationSave.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/SaveConfigurationParameter" - }, - "description": "Save Configuration parameters." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ConfigurationParameter" - } - ], - "responses": { - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked.", - "headers": { - "location": { - "type": "string" - } - } - }, - "200": { - "description": "Result of creating a commit in the repository.", - "schema": { - "$ref": "./definitions.json#/definitions/OperationResultContract" - } - }, - "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.ApiManagement/service/{serviceName}/tenant/{configurationName}/validate": { - "post": { - "tags": [ - "TenantConfiguration" - ], - "operationId": "TenantConfiguration_Validate", - "description": "This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.", - "x-ms-examples": { - "ApiManagementTenantConfigurationValidate": { - "$ref": "./examples/ApiManagementTenantConfigurationValidate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/DeployConfigurationParameters" - }, - "description": "Validate Configuration parameters." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ConfigurationParameter" - } - ], - "responses": { - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked.", - "headers": { - "location": { - "type": "string" - } - } - }, - "200": { - "description": "Result of validating the changes in the specified Git branch.", - "schema": { - "$ref": "./definitions.json#/definitions/OperationResultContract" - } - }, - "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.ApiManagement/service/{serviceName}/tenant/{configurationName}/syncState": { - "get": { - "tags": [ - "TenantConfigurationSyncState" - ], - "operationId": "TenantConfiguration_GetSyncState", - "description": "Gets the status of the most recent synchronization between the configuration database and the Git repository.", - "x-ms-examples": { - "ApiManagementTenantAccessSyncState": { - "$ref": "./examples/ApiManagementTenantAccessSyncState.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ConfigurationParameter" - } - ], - "responses": { - "200": { - "description": "Sync state result.", - "schema": { - "$ref": "./definitions.json#/definitions/TenantConfigurationSyncStateContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimusers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimusers.json deleted file mode 100644 index ff5f502454b0..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimusers.json +++ /dev/null @@ -1,792 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on User entity in Azure API Management deployment. The User entity in API Management represents the developers that call the APIs of the products to which they are subscribed.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/users": { - "get": { - "tags": [ - "User" - ], - "operationId": "User_ListByService", - "description": "Lists a collection of registered users in the specified service instance.", - "x-ms-examples": { - "ApiManagementListUsers": { - "$ref": "./examples/ApiManagementListUsers.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| groups | expand | | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "expandGroups", - "in": "query", - "type": "boolean", - "description": "Detailed Group in response." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of User entities.", - "schema": { - "$ref": "./definitions.json#/definitions/UserCollection" - } - }, - "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-odata": "./definitions.json#/definitions/UserContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}": { - "head": { - "tags": [ - "User" - ], - "operationId": "User_GetEntityTag", - "description": "Gets the entity state (Etag) version of the user specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadUser": { - "$ref": "./examples/ApiManagementHeadUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified user entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "User" - ], - "operationId": "User_Get", - "description": "Gets the details of the user specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetUser": { - "$ref": "./examples/ApiManagementGetUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the specified user entity.", - "schema": { - "$ref": "./definitions.json#/definitions/UserContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "User" - ], - "operationId": "User_CreateOrUpdate", - "description": "Creates or Updates a user.", - "x-ms-examples": { - "ApiManagementCreateUser": { - "$ref": "./examples/ApiManagementCreateUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/UserCreateParameters" - }, - "description": "Create or update parameters." - }, - { - "name": "notify", - "in": "query", - "required": false, - "type": "boolean", - "description": "Send an Email notification to the User." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "User was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/UserContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "User was successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/UserContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "User" - ], - "operationId": "User_Update", - "description": "Updates the details of the user specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateUser": { - "$ref": "./examples/ApiManagementUpdateUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/UserUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "User was successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/UserContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "User" - ], - "operationId": "User_Delete", - "description": "Deletes specific user.", - "x-ms-examples": { - "ApiManagementDeleteUser": { - "$ref": "./examples/ApiManagementDeleteUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "name": "deleteSubscriptions", - "in": "query", - "required": false, - "type": "boolean", - "description": "Whether to delete user's subscription or not." - }, - { - "name": "notify", - "in": "query", - "required": false, - "type": "boolean", - "description": "Send an Account Closed Email notification to the User." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AppTypeParameter" - } - ], - "responses": { - "202": { - "description": "Request to delete user details was accepted.", - "headers": { - "location": { - "description": "Location header", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "204": { - "description": "The user details were successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/users/{userId}/generateSsoUrl": { - "post": { - "tags": [ - "Users" - ], - "operationId": "User_GenerateSsoUrl", - "description": "Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.", - "x-ms-examples": { - "ApiManagementUserGenerateSsoUrl": { - "$ref": "./examples/ApiManagementUserGenerateSsoUrl.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the single sign-on URL.", - "schema": { - "x-ms-client-flatten": true, - "$ref": "./definitions.json#/definitions/GenerateSsoUrlResult" - } - }, - "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.ApiManagement/service/{serviceName}/users/{userId}/groups": { - "get": { - "tags": [ - "UserGroup" - ], - "operationId": "UserGroup_List", - "description": "Lists all user groups.", - "x-ms-examples": { - "ApiManagementListUserGroups": { - "$ref": "./examples/ApiManagementListUserGroups.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|------------------------|-----------------------------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Group entities.", - "schema": { - "$ref": "./definitions.json#/definitions/GroupCollection" - } - }, - "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-odata": "./definitions.json#/definitions/GroupContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions": { - "get": { - "tags": [ - "UserSubscription" - ], - "operationId": "UserSubscription_List", - "description": "Lists the collection of subscriptions of the specified user.", - "x-ms-examples": { - "ApiManagementListUserSubscriptions": { - "$ref": "./examples/ApiManagementListUserSubscriptions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|------------------------|-----------------------------------|
|name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Subscription entities.", - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionCollection" - } - }, - "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-odata": "./definitions.json#/definitions/SubscriptionContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions/{sid}": { - "get": { - "tags": [ - "Subscription" - ], - "operationId": "UserSubscription_Get", - "description": "Gets the specified Subscription entity associated with a particular user.", - "x-ms-examples": { - "ApiManagementGetUserSubscription": { - "$ref": "./examples/ApiManagementGetUserSubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Subscription entity.", - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "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.ApiManagement/service/{serviceName}/users/{userId}/identities": { - "get": { - "tags": [ - "UserIdentity" - ], - "operationId": "UserIdentities_List", - "description": "List of all user identities.", - "x-ms-examples": { - "ApiManagementListUserIdentities": { - "$ref": "./examples/ApiManagementListUserIdentities.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists of User Identities.", - "schema": { - "$ref": "./definitions.json#/definitions/UserIdentityCollection" - } - }, - "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.ApiManagement/service/{serviceName}/users/{userId}/token": { - "post": { - "tags": [ - "UserToken" - ], - "operationId": "User_GetSharedAccessToken", - "description": "Gets the Shared Access Authorization Token for the User.", - "x-ms-examples": { - "ApiManagementUserToken": { - "$ref": "./examples/ApiManagementUserToken.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/UserTokenParameters" - }, - "description": "Create Authorization Token parameters." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the authorization token for the user.", - "schema": { - "x-ms-client-flatten": true, - "$ref": "./definitions.json#/definitions/UserTokenResult" - } - }, - "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.ApiManagement/service/{serviceName}/users/{userId}/confirmations/password/send": { - "post": { - "tags": [ - "UserConfirmationPasswordSend" - ], - "operationId": "UserConfirmationPassword_Send", - "description": "Sends confirmation", - "x-ms-examples": { - "ApiManagementUserConfirmationPasswordSend": { - "$ref": "./examples/ApiManagementUserConfirmationPasswordSend.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AppTypeParameter" - } - ], - "responses": { - "204": { - "description": "Notification successfully sent" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspacebackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspacebackends.json deleted file mode 100644 index 2184b117dda3..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspacebackends.json +++ /dev/null @@ -1,397 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Backend entity in Azure API Management deployment. The Backend entity in API Management represents a backend service that is configured to skip certification chain validation when using a self-signed certificate to test mutual certificate authentication.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/backends": { - "get": { - "tags": [ - "Backend" - ], - "operationId": "WorkspaceBackend_ListByWorkspace", - "description": "Lists a collection of backends in the specified workspace.", - "x-ms-examples": { - "ApiManagementListWorkspaceBackends": { - "$ref": "./examples/ApiManagementListWorkspaceBackends.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Backend entities.", - "schema": { - "$ref": "./definitions.json#/definitions/BackendCollection" - } - }, - "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-odata": "./definitions.json#/definitions/BackendContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/backends/{backendId}": { - "head": { - "tags": [ - "Backend" - ], - "operationId": "WorkspaceBackend_GetEntityTag", - "description": "Gets the entity state (Etag) version of the backend specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceBackend": { - "$ref": "./examples/ApiManagementHeadWorkspaceBackend.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/BackendIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified backend entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Backend" - ], - "operationId": "WorkspaceBackend_Get", - "description": "Gets the details of the backend specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspaceBackend": { - "$ref": "./examples/ApiManagementGetWorkspaceBackend.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/BackendIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Backend entity.", - "schema": { - "$ref": "./definitions.json#/definitions/BackendContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Backend" - ], - "operationId": "WorkspaceBackend_CreateOrUpdate", - "description": "Creates or Updates a backend.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceBackendServiceFabric": { - "$ref": "./examples/ApiManagementCreateWorkspaceBackendServiceFabric.json" - }, - "ApiManagementCreateWorkspaceBackendProxyBackend": { - "$ref": "./examples/ApiManagementCreateWorkspaceBackendProxyBackend.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/BackendIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/BackendContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Backend was successfully created.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/BackendContract" - } - }, - "200": { - "description": "The existing backend was successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/BackendContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Backend" - ], - "operationId": "WorkspaceBackend_Update", - "description": "Updates an existing backend.", - "x-ms-examples": { - "ApiManagementUpdateWorkspaceBackend": { - "$ref": "./examples/ApiManagementUpdateWorkspaceBackend.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/BackendIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/BackendUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The existing backend was successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/BackendContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Backend" - ], - "operationId": "WorkspaceBackend_Delete", - "description": "Deletes the specified backend.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceBackend": { - "$ref": "./examples/ApiManagementDeleteWorkspaceBackend.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/BackendIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The backend was successfully deleted." - }, - "204": { - "description": "The backend was successfully deleted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspacecertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspacecertificates.json deleted file mode 100644 index 3cf2a35a0fa0..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspacecertificates.json +++ /dev/null @@ -1,405 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Certificate entity in your Azure API Management deployment. Certificates can be used to setup mutual authentication with your Backend in API Management. For more information refer to [How to secure backend using Mutual Auth Certificate](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-mutual-certificates).", - "version": "2024-10-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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates": { - "get": { - "tags": [ - "Certificate" - ], - "operationId": "WorkspaceCertificate_ListByWorkspace", - "description": "Lists a collection of all certificates in the specified workspace.", - "x-ms-examples": { - "ApiManagementListWorkspaceCertificates": { - "$ref": "./examples/ApiManagementListWorkspaceCertificates.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| expirationDate | filter | ge, le, eq, ne, gt, lt | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "isKeyVaultRefreshFailed", - "in": "query", - "required": false, - "type": "boolean", - "description": "When set to true, the response contains only certificates entities which failed refresh." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Returns a collection of Certificate entity.", - "schema": { - "$ref": "./definitions.json#/definitions/CertificateCollection" - } - }, - "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-odata": "./definitions.json#/definitions/CertificateContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates/{certificateId}": { - "head": { - "tags": [ - "Certificate" - ], - "operationId": "WorkspaceCertificate_GetEntityTag", - "description": "Gets the entity state (Etag) version of the certificate specified by its identifier.", - "x-ms-examples": { - "ApiManagementWorkspaceHeadCertificate": { - "$ref": "./examples/ApiManagementHeadWorkspaceCertificate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified certificate entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Certificate" - ], - "operationId": "WorkspaceCertificate_Get", - "description": "Gets the details of the certificate specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspaceCertificate": { - "$ref": "./examples/ApiManagementGetWorkspaceCertificate.json" - }, - "ApiManagementGetWorkspaceCertificateWithKeyVault": { - "$ref": "./examples/ApiManagementGetWorkspaceCertificateWithKeyVault.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Certificate entity.", - "schema": { - "$ref": "./definitions.json#/definitions/CertificateContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Certificate" - ], - "operationId": "WorkspaceCertificate_CreateOrUpdate", - "description": "Creates or updates the certificate being used for authentication with the backend.", - "externalDocs": { - "description": "How to secure back-end services using client certificate authentication in Azure API Management", - "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/" - }, - "x-ms-examples": { - "ApiManagementCreateWorkspaceCertificate": { - "$ref": "./examples/ApiManagementCreateWorkspaceCertificate.json" - }, - "ApiManagementCreateWorkspaceCertificateWithKeyVault": { - "$ref": "./examples/ApiManagementCreateWorkspaceCertificateWithKeyVault.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/CertificateCreateOrUpdateParameters" - }, - "description": "Create or Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "The new certificate was successfully added.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/CertificateContract" - } - }, - "200": { - "description": "The certificate details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/CertificateContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Certificate" - ], - "operationId": "WorkspaceCertificate_Delete", - "description": "Deletes specific certificate.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceCertificate": { - "$ref": "./examples/ApiManagementDeleteWorkspaceCertificate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The certificate was successfully deleted." - }, - "204": { - "description": "The certificate was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates/{certificateId}/refreshSecret": { - "post": { - "tags": [ - "Certificate" - ], - "operationId": "WorkspaceCertificate_RefreshSecret", - "description": "From KeyVault, Refresh the certificate being used for authentication with the backend.", - "externalDocs": { - "description": "How to secure back-end services using client certificate authentication in Azure API Management", - "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/" - }, - "x-ms-examples": { - "ApiManagementRefreshWorkspaceCertificate": { - "$ref": "./examples/ApiManagementRefreshWorkspaceCertificate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/CertificateIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The certificate details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/CertificateContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspacediagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspacediagnostics.json deleted file mode 100644 index f97bb49538b0..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspacediagnostics.json +++ /dev/null @@ -1,766 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Diagnostic entity associated with your Azure API Management deployment. Diagnostics are used to log requests/responses in the API Management proxy.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/diagnostics": { - "get": { - "tags": [ - "Diagnostic" - ], - "operationId": "WorkspaceDiagnostic_ListByWorkspace", - "description": "Lists all diagnostics in the specified workspace.", - "x-ms-examples": { - "ApiManagementListWorkspaceDiagnostics": { - "$ref": "./examples/ApiManagementListWorkspaceDiagnostics.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Paged Result response of diagnostics.", - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticCollection" - } - }, - "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-odata": "./definitions.json#/definitions/DiagnosticContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/diagnostics/{diagnosticId}": { - "head": { - "tags": [ - "Diagnostic" - ], - "operationId": "WorkspaceDiagnostic_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Diagnostic specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceDiagnostic": { - "$ref": "./examples/ApiManagementHeadWorkspaceDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the entity tag of the diagnostic", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Diagnostic" - ], - "operationId": "WorkspaceDiagnostic_Get", - "description": "Gets the details of the Diagnostic specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspaceDiagnostic": { - "$ref": "./examples/ApiManagementGetWorkspaceDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Diagnostic entity.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Diagnostic" - ], - "operationId": "WorkspaceDiagnostic_CreateOrUpdate", - "description": "Creates a new Diagnostic or updates an existing one.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceDiagnostic": { - "$ref": "./examples/ApiManagementCreateWorkspaceDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Diagnostic was successfully created.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - } - }, - "200": { - "description": "Diagnostic successfully updated", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Diagnostic" - ], - "operationId": "WorkspaceDiagnostic_Update", - "description": "Updates the details of the Diagnostic specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateWorkspaceDiagnostic": { - "$ref": "./examples/ApiManagementUpdateWorkspaceDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticUpdateContract" - }, - "description": "Diagnostic Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Diagnostic successfully updated", - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Diagnostic" - ], - "operationId": "WorkspaceDiagnostic_Delete", - "description": "Deletes the specified Diagnostic.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceDiagnostic": { - "$ref": "./examples/ApiManagementDeleteWorkspaceDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The Diagnostic was successfully deleted." - }, - "204": { - "description": "The Diagnostic was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics": { - "get": { - "tags": [ - "ApiDiagnostic" - ], - "operationId": "WorkspaceApiDiagnostic_ListByWorkspace", - "description": "Lists all diagnostics of an API.", - "x-ms-examples": { - "ApiManagementListWorkspaceApiDiagnostics": { - "$ref": "./examples/ApiManagementListWorkspaceApiDiagnostics.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Paged Result response of diagnostics for an API.", - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticCollection" - } - }, - "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-odata": "./definitions.json#/definitions/DiagnosticContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId}": { - "head": { - "tags": [ - "ApiDiagnostic" - ], - "operationId": "WorkspaceApiDiagnostic_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceApiDiagnostic": { - "$ref": "./examples/ApiManagementHeadWorkspaceApiDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiDiagnostic" - ], - "operationId": "WorkspaceApiDiagnostic_Get", - "description": "Gets the details of the Diagnostic for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspaceApiDiagnostic": { - "$ref": "./examples/ApiManagementGetWorkspaceApiDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Diagnostic entity.", - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiDiagnostic" - ], - "operationId": "WorkspaceApiDiagnostic_CreateOrUpdate", - "description": "Creates a new Diagnostic for an API or updates an existing one.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceApiDiagnostic": { - "$ref": "./examples/ApiManagementCreateWorkspaceApiDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Diagnostic was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Diagnostic was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "ApiDiagnostic" - ], - "operationId": "WorkspaceApiDiagnostic_Update", - "description": "Updates the details of the Diagnostic for an API specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateWorkspaceApiDiagnostic": { - "$ref": "./examples/ApiManagementUpdateWorkspaceApiDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticUpdateContract" - }, - "description": "Diagnostic Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Diagnostic was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/DiagnosticContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiDiagnostic" - ], - "operationId": "WorkspaceApiDiagnostic_Delete", - "description": "Deletes the specified Diagnostic from an API.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceApiDiagnostic": { - "$ref": "./examples/ApiManagementDeleteWorkspaceApiDiagnostic.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/DiagnosticIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Diagnostic successfully removed" - }, - "204": { - "description": "Diagnostic successfully removed by previous request or does not exist" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspacelinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspacelinks.json deleted file mode 100644 index 9ee20a7cbef8..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspacelinks.json +++ /dev/null @@ -1,129 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs to manage Azure API Management WorkspaceLinks deployments.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/workspaceLinks": { - "get": { - "tags": [ - "ApiManagementWorkspaceLinks" - ], - "operationId": "ApiManagementWorkspaceLinks_ListByService", - "description": "List all API Management workspaceLinks for a service.", - "x-ms-examples": { - "ApiManagementListGatewayConfigConnection": { - "$ref": "./examples/ApiManagementListWorkspaceLinks.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - } - ], - "responses": { - "200": { - "description": "The API Management gateway workspaceLinks list.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiManagementWorkspaceLinksListResult" - } - }, - "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.ApiManagement/service/{serviceName}/workspaceLinks/{workspaceId}": { - "get": { - "tags": [ - "ApiManagementWorkspaceLinks" - ], - "operationId": "ApiManagementWorkspaceLink_Get", - "description": "Gets an API Management WorkspaceLink resource description.", - "x-ms-examples": { - "ApiManagementGetWorkspaceLinks": { - "$ref": "./examples/ApiManagementGetWorkspaceLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully got the API Management WorkspaceLink resource.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiManagementWorkspaceLinksResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspaceloggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspaceloggers.json deleted file mode 100644 index 8a8983ef9873..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspaceloggers.json +++ /dev/null @@ -1,400 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on logger entity Azure API Management deployment.The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure EventHub.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/loggers": { - "get": { - "tags": [ - "Logger" - ], - "operationId": "WorkspaceLogger_ListByWorkspace", - "description": "Lists a collection of loggers in the specified workspace.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-log-event-hubs" - }, - "x-ms-examples": { - "ApiManagementListWorkspaceLoggers": { - "$ref": "./examples/ApiManagementListWorkspaceLoggers.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| loggerType | filter | eq | |
| resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Logger entities.", - "schema": { - "$ref": "./definitions.json#/definitions/LoggerCollection" - } - }, - "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-odata": "./definitions.json#/definitions/LoggerContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/loggers/{loggerId}": { - "head": { - "tags": [ - "Logger" - ], - "operationId": "WorkspaceLogger_GetEntityTag", - "description": "Gets the entity state (Etag) version of the logger specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceLogger": { - "$ref": "./examples/ApiManagementHeadWorkspaceLogger.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified logger entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Logger" - ], - "operationId": "WorkspaceLogger_Get", - "description": "Gets the details of the logger specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspaceLogger": { - "$ref": "./examples/ApiManagementGetWorkspaceLogger.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Logger entity.", - "schema": { - "$ref": "./definitions.json#/definitions/LoggerContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Logger" - ], - "operationId": "WorkspaceLogger_CreateOrUpdate", - "description": "Creates or Updates a logger.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceEHLogger": { - "$ref": "./examples/ApiManagementCreateWorkspaceEHLogger.json" - }, - "ApiManagementCreateWorkspaceAILogger": { - "$ref": "./examples/ApiManagementCreateWorkspaceAILogger.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/LoggerContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Logger was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/LoggerContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "The existing logger was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/LoggerContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Logger" - ], - "operationId": "WorkspaceLogger_Update", - "description": "Updates an existing logger.", - "x-ms-examples": { - "ApiManagementUpdateWorkspaceLogger": { - "$ref": "./examples/ApiManagementUpdateWorkspaceLogger.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/LoggerUpdateContract" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The existing logger was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/LoggerContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Logger" - ], - "operationId": "WorkspaceLogger_Delete", - "description": "Deletes the specified logger.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceLogger": { - "$ref": "./examples/ApiManagementDeleteWorkspaceLogger.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/LoggerIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The logger was successfully deleted." - }, - "204": { - "description": "The logger was successfully deleted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspaces.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspaces.json deleted file mode 100644 index 2e9831c95d76..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/apimworkspaces.json +++ /dev/null @@ -1,8367 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs for performing operations on Workspace entity and its associated entities within your Azure API Management deployment.", - "version": "2024-10-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.ApiManagement/service/{serviceName}/workspaces": { - "get": { - "tags": [ - "Workspace" - ], - "operationId": "Workspace_ListByService", - "description": "Lists all workspaces of the API Management service instance.", - "x-ms-examples": { - "ApiManagementListWorkspaces": { - "$ref": "./examples/ApiManagementListWorkspaces.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Paged Result response of workspaces.", - "schema": { - "$ref": "./definitions.json#/definitions/WorkspaceCollection" - } - }, - "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-odata": "./definitions.json#/definitions/WorkspaceContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}": { - "head": { - "tags": [ - "Workspace" - ], - "operationId": "Workspace_GetEntityTag", - "description": "Gets the entity state (Etag) version of the workspace specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspace": { - "$ref": "./examples/ApiManagementHeadWorkspace.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the entity tag of the workspace", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Workspace" - ], - "operationId": "Workspace_Get", - "description": "Gets the details of the workspace specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspace": { - "$ref": "./examples/ApiManagementGetWorkspace.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified workspace entity.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/WorkspaceContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Workspace" - ], - "operationId": "Workspace_CreateOrUpdate", - "description": "Creates a new workspace or updates an existing one.", - "x-ms-examples": { - "ApiManagementCreateWorkspace": { - "$ref": "./examples/ApiManagementCreateWorkspace.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/WorkspaceContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Workspace was successfully created.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/WorkspaceContract" - } - }, - "200": { - "description": "Workspace successfully updated", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/WorkspaceContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Workspace" - ], - "operationId": "Workspace_Update", - "description": "Updates the details of the workspace specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateWorkspace": { - "$ref": "./examples/ApiManagementUpdateWorkspace.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/WorkspaceContract" - }, - "description": "Workspace Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Workspace successfully updated", - "schema": { - "$ref": "./definitions.json#/definitions/WorkspaceContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Workspace" - ], - "operationId": "Workspace_Delete", - "description": "Deletes the specified workspace.", - "x-ms-examples": { - "ApiManagementDeleteWorkspace": { - "$ref": "./examples/ApiManagementDeleteWorkspace.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The workspace was successfully deleted." - }, - "204": { - "description": "The workspace was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies": { - "get": { - "tags": [ - "WorkspacePolicy" - ], - "operationId": "WorkspacePolicy_ListByApi", - "description": "Get the policy configuration at the workspace level.", - "x-ms-examples": { - "ApiManagementListWorkspacePolicies": { - "$ref": "./examples/ApiManagementListWorkspacePolicies.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Workspace Policy Collection.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyCollection" - } - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies/{policyId}": { - "head": { - "tags": [ - "WorkspacePolicy" - ], - "operationId": "WorkspacePolicy_GetEntityTag", - "description": "Gets the entity state (Etag) version of the workspace policy specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspacePolicy": { - "$ref": "./examples/ApiManagementHeadWorkspacePolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified workspace Policy entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "WorkspacePolicy" - ], - "operationId": "WorkspacePolicy_Get", - "description": "Get the policy configuration at the API level.", - "x-ms-examples": { - "ApiManagementGetWorkspacePolicy": { - "$ref": "./examples/ApiManagementGetWorkspacePolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Workspace Policy information.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "WorkspacePolicy" - ], - "operationId": "WorkspacePolicy_CreateOrUpdate", - "description": "Creates or updates policy configuration for the workspace.", - "x-ms-examples": { - "ApiManagementCreateWorkspacePolicy": { - "$ref": "./examples/ApiManagementCreateWorkspacePolicy.json" - }, - "ApiManagementCreateWorkspacePolicyNonXmlEncoded": { - "$ref": "./examples/ApiManagementCreateWorkspacePolicyNonXmlEncoded.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "description": "The policy contents to apply." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Workspace policy configuration was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Workspace policy configuration of the tenant was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "WorkspacePolicy" - ], - "operationId": "WorkspacePolicy_Delete", - "description": "Deletes the policy configuration at the workspace.", - "x-ms-examples": { - "ApiManagementDeleteWorkspacePolicy": { - "$ref": "./examples/ApiManagementDeleteWorkspacePolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the policy configuration at the workspace level." - }, - "204": { - "description": "Successfully deleted the policy configuration at the workspace level." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues": { - "get": { - "tags": [ - "NamedValue" - ], - "operationId": "WorkspaceNamedValue_ListByService", - "description": "Lists a collection of named values defined within a workspace in a service instance.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties" - }, - "x-ms-examples": { - "ApiManagementListWorkspaceNamedValues": { - "$ref": "./examples/ApiManagementListWorkspaceNamedValues.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "isKeyVaultRefreshFailed", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "true", - "false" - ], - "x-ms-enum": { - "name": "KeyVaultRefreshState", - "modelAsString": true, - "values": [ - { - "value": "true", - "description": "Entities for which KeyVault refresh failed." - }, - { - "value": "false", - "description": "Entities for which KeyVault refresh succeeded" - } - ] - }, - "description": "Query parameter to fetch named value entities based on refresh status." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A Collection of the named value entities for the specified workspace in an API Management service instance.", - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueCollection" - } - }, - "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-odata": "./definitions.json#/definitions/NamedValueContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}": { - "head": { - "tags": [ - "NamedValue" - ], - "operationId": "WorkspaceNamedValue_GetEntityTag", - "description": "Gets the entity state (Etag) version of the named value specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceNamedValue": { - "$ref": "./examples/ApiManagementHeadWorkspaceNamedValue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified named value entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "NamedValue" - ], - "operationId": "WorkspaceNamedValue_Get", - "description": "Gets the details of the named value specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspaceNamedValue": { - "$ref": "./examples/ApiManagementGetWorkspaceNamedValue.json" - }, - "ApiManagementGetWorkspaceNamedValueWithKeyVault": { - "$ref": "./examples/ApiManagementGetWorkspaceNamedValueWithKeyVault.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified named value entity. No secrets included", - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "NamedValue" - ], - "operationId": "WorkspaceNamedValue_CreateOrUpdate", - "description": "Creates or updates named value.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceNamedValue": { - "$ref": "./examples/ApiManagementCreateWorkspaceNamedValue.json" - }, - "ApiManagementCreateWorkspaceNamedValueWithKeyVault": { - "$ref": "./examples/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueCreateContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Named value was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "200": { - "description": "Named value was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "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" - } - }, - "patch": { - "tags": [ - "NamedValue" - ], - "operationId": "WorkspaceNamedValue_Update", - "description": "Updates the specific named value.", - "x-ms-examples": { - "ApiManagementUpdateWorkspaceNamedValue": { - "$ref": "./examples/ApiManagementUpdateWorkspaceNamedValue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "Request to create or update named value was accepted.", - "headers": { - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "200": { - "description": "Named value was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "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" - } - }, - "delete": { - "tags": [ - "NamedValue" - ], - "operationId": "WorkspaceNamedValue_Delete", - "description": "Deletes specific named value from the workspace in an API Management service instance.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceNamedValue": { - "$ref": "./examples/ApiManagementDeleteWorkspaceNamedValue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Named value was successfully deleted." - }, - "204": { - "description": "Named value was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}/listValue": { - "post": { - "tags": [ - "NamedValue" - ], - "operationId": "WorkspaceNamedValue_ListValue", - "description": "Gets the secret of the named value specified by its identifier.", - "x-ms-examples": { - "ApiManagementWorkspaceNamedValueListValue": { - "$ref": "./examples/ApiManagementWorkspaceNamedValueListValue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified named value secret.", - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueSecretContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}/refreshSecret": { - "post": { - "tags": [ - "NamedValue" - ], - "operationId": "WorkspaceNamedValue_RefreshSecret", - "description": "Refresh the secret of the named value specified by its identifier.", - "x-ms-examples": { - "ApiManagementRefreshWorkspaceNamedValue": { - "$ref": "./examples/ApiManagementRefreshWorkspaceNamedValue.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NamedValueIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "Request to refresh secret was accepted.", - "headers": { - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "200": { - "description": "Named value was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/NamedValueContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas": { - "get": { - "tags": [ - "Schema" - ], - "operationId": "WorkspaceGlobalSchema_ListByService", - "description": "Lists a collection of schemas registered with workspace in a service instance.", - "x-ms-examples": { - "ApiManagementListWorkspaceSchemas": { - "$ref": "./examples/ApiManagementListWorkspaceSchemas.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Schema entities.", - "schema": { - "$ref": "./definitions.json#/definitions/GlobalSchemaCollection" - } - }, - "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-odata": "./definitions.json#/definitions/GlobalSchemaContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId}": { - "head": { - "tags": [ - "Schema" - ], - "operationId": "WorkspaceGlobalSchema_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Schema specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceSchema": { - "$ref": "./examples/ApiManagementHeadWorkspaceSchema.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified Schema entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Schema" - ], - "operationId": "WorkspaceGlobalSchema_Get", - "description": "Gets the details of the Schema specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspaceSchema": { - "$ref": "./examples/ApiManagementGetWorkspaceSchema.json" - } - }, - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Schema entity.", - "schema": { - "$ref": "./definitions.json#/definitions/GlobalSchemaContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Schema" - ], - "operationId": "WorkspaceGlobalSchema_CreateOrUpdate", - "description": "Creates new or updates existing specified Schema of the workspace in an API Management service instance.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceSchema": { - "$ref": "./examples/ApiManagementCreateWorkspaceSchema.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/GlobalSchemaContract" - }, - "description": "Create or update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "The new Schema was successfully added.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/GlobalSchemaContract" - } - }, - "200": { - "description": "The Schema details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/GlobalSchemaContract" - } - }, - "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" - } - }, - "delete": { - "tags": [ - "Schema" - ], - "operationId": "WorkspaceGlobalSchema_Delete", - "description": "Deletes specific Schema.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceSchema": { - "$ref": "./examples/ApiManagementDeleteWorkspaceSchema.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The Schema was successfully deleted." - }, - "204": { - "description": "The Schema was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications": { - "get": { - "tags": [ - "Notification" - ], - "operationId": "WorkspaceNotification_ListByService", - "description": "Lists a collection of properties defined within a service instance.", - "x-ms-examples": { - "ApiManagementListWorkspaceNotifications": { - "$ref": "./examples/ApiManagementListWorkspaceNotifications.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A Collection of the Notification for the specified workspace in a API Management service instance.", - "schema": { - "$ref": "./definitions.json#/definitions/NotificationCollection" - } - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}": { - "get": { - "tags": [ - "Notification" - ], - "operationId": "WorkspaceNotification_Get", - "description": "Gets the details of the Notification specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspaceNotification": { - "$ref": "./examples/ApiManagementGetWorkspaceNotification.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Notification.", - "schema": { - "$ref": "./definitions.json#/definitions/NotificationContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Notification" - ], - "operationId": "WorkspaceNotification_CreateOrUpdate", - "description": "Create or Update API Management publisher notification for the workspace.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceNotification": { - "$ref": "./examples/ApiManagementCreateWorkspaceNotification.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Notification was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/NotificationContract" - } - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientUsers": { - "get": { - "tags": [ - "NotificationRecipientUser" - ], - "operationId": "WorkspaceNotificationRecipientUser_ListByNotification", - "description": "Gets the list of the Notification Recipient User subscribed to the notification.", - "x-ms-examples": { - "ApiManagementListWorkspaceNotificationRecipientUsers": { - "$ref": "./examples/ApiManagementListWorkspaceNotificationRecipientUsers.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the Recipient User collection for the notification.", - "schema": { - "$ref": "./definitions.json#/definitions/RecipientUserCollection" - } - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientUsers/{userId}": { - "head": { - "tags": [ - "NotificationRecipientUser" - ], - "operationId": "WorkspaceNotificationRecipientUser_CheckEntityExists", - "description": "Determine if the Notification Recipient User is subscribed to the notification.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceNotificationRecipientUser": { - "$ref": "./examples/ApiManagementHeadWorkspaceNotificationRecipientUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "The User is subscribed to receive the notification." - }, - "404": { - "description": "Entity does not exists." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "NotificationRecipientUser" - ], - "operationId": "WorkspaceNotificationRecipientUser_CreateOrUpdate", - "description": "Adds the API Management User to the list of Recipients for the Notification.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceNotificationRecipientUser": { - "$ref": "./examples/ApiManagementCreateWorkspaceNotificationRecipientUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Recipient User was successfully added to the notification list.", - "schema": { - "$ref": "./definitions.json#/definitions/RecipientUserContract" - } - }, - "200": { - "description": "Recipient User is already part of the notification list.", - "schema": { - "$ref": "./definitions.json#/definitions/RecipientUserContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "NotificationRecipientUser" - ], - "operationId": "WorkspaceNotificationRecipientUser_Delete", - "description": "Removes the API Management user from the list of Notification.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceNotificationRecipientUser": { - "$ref": "./examples/ApiManagementDeleteWorkspaceNotificationRecipientUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Recipient User was successfully removed from the notification list." - }, - "204": { - "description": "Recipient User was successfully removed from the notification list." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientEmails": { - "get": { - "tags": [ - "NotificationRecipientEmail" - ], - "operationId": "WorkspaceNotificationRecipientEmail_ListByNotification", - "description": "Gets the list of the Notification Recipient Emails subscribed to a notification.", - "x-ms-examples": { - "ApiManagementListWorkspaceNotificationRecipientEmails": { - "$ref": "./examples/ApiManagementListWorkspaceNotificationRecipientEmails.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the Recipient Email collection subscribed to the notification.", - "schema": { - "$ref": "./definitions.json#/definitions/RecipientEmailCollection" - } - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientEmails/{email}": { - "head": { - "tags": [ - "NotificationRecipientEmail" - ], - "operationId": "WorkspaceNotificationRecipientEmail_CheckEntityExists", - "description": "Determine if Notification Recipient Email subscribed to the notification.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceNotificationRecipientEmail": { - "$ref": "./examples/ApiManagementHeadWorkspaceNotificationRecipientEmail.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/EmailParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "The Users is subscribed to receive the notification." - }, - "404": { - "description": "The Users is not subscribed to receive the notification." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "NotificationRecipientEmail" - ], - "operationId": "WorkspaceNotificationRecipientEmail_CreateOrUpdate", - "description": "Adds the Email address to the list of Recipients for the Notification.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceNotificationRecipientEmail": { - "$ref": "./examples/ApiManagementCreateWorkspaceNotificationRecipientEmail.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/EmailParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Recipient Email was successfully added to the notification list.", - "schema": { - "$ref": "./definitions.json#/definitions/RecipientEmailContract" - } - }, - "200": { - "description": "Recipient Email is already part of the notification list.", - "schema": { - "$ref": "./definitions.json#/definitions/RecipientEmailContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "NotificationRecipientEmail" - ], - "operationId": "WorkspaceNotificationRecipientEmail_Delete", - "description": "Removes the email from the list of Notification.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceNotificationRecipientEmail": { - "$ref": "./examples/ApiManagementDeleteWorkspaceNotificationRecipientEmail.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/NotificationNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/EmailParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Recipient Email was successfully removed to the notification list." - }, - "204": { - "description": "Recipient Email was successfully removed to the notification list." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments": { - "get": { - "tags": [ - "PolicyFragment" - ], - "operationId": "WorkspacePolicyFragment_ListByService", - "description": "Gets all policy fragments defined within a workspace.", - "x-ms-examples": { - "ApiManagementListWorkspacePolicyFragments": { - "$ref": "./examples/ApiManagementListWorkspacePolicyFragments.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter, orderBy | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| value | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "name": "$orderby", - "in": "query", - "required": false, - "type": "string", - "description": "OData order by query option." - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - } - ], - "responses": { - "200": { - "description": "Successfully returned an array of policy fragments.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyFragmentCollection" - } - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}": { - "head": { - "tags": [ - "PolicyFragment" - ], - "operationId": "WorkspacePolicyFragment_GetEntityTag", - "description": "Gets the entity state (Etag) version of a policy fragment.", - "x-ms-examples": { - "ApiManagementHeadWorkspacePolicyFragment": { - "$ref": "./examples/ApiManagementHeadWorkspacePolicyFragment.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The specified policy fragment exists and the current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "PolicyFragment" - ], - "operationId": "WorkspacePolicyFragment_Get", - "description": "Gets a policy fragment.", - "x-ms-examples": { - "ApiManagementGetWorkspacePolicyFragment": { - "$ref": "./examples/ApiManagementGetWorkspacePolicyFragment.json" - }, - "ApiManagementGetWorkspacePolicyFragmentFormat": { - "$ref": "./examples/ApiManagementGetWorkspacePolicyFragmentFormat.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyFragmentContentFormat" - } - ], - "responses": { - "200": { - "description": "Successfully returned a policy fragment.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyFragmentContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "PolicyFragment" - ], - "operationId": "WorkspacePolicyFragment_CreateOrUpdate", - "description": "Creates or updates a policy fragment.", - "x-ms-examples": { - "ApiManagementCreateWorkspacePolicyFragment": { - "$ref": "./examples/ApiManagementCreateWorkspacePolicyFragment.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PolicyFragmentContract" - }, - "description": "The policy fragment contents to apply." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The policy fragment was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyFragmentContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "201": { - "description": "The policy fragment was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyFragmentContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "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" - } - }, - "delete": { - "tags": [ - "PolicyFragment" - ], - "operationId": "WorkspacePolicyFragment_Delete", - "description": "Deletes a policy fragment.", - "x-ms-examples": { - "ApiManagementDeleteWorkspacePolicyFragment": { - "$ref": "./examples/ApiManagementDeleteWorkspacePolicyFragment.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The policy fragment was successfully removed." - }, - "204": { - "description": "The policy fragment successfully removed by previous request or does not exist." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}/listReferences": { - "post": { - "tags": [ - "PolicyFragment" - ], - "operationId": "WorkspacePolicyFragment_ListReferences", - "description": "Lists policy resources that reference the policy fragment.", - "x-ms-examples": { - "ApiManagementListWorkspacePolicyFragmentReferences": { - "$ref": "./examples/ApiManagementListWorkspacePolicyFragmentReferences.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - } - ], - "responses": { - "200": { - "description": "Successfully returned an array of references to policy resources that include the policy fragment in their definitions.", - "schema": { - "$ref": "./definitions.json#/definitions/ResourceCollection" - } - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups": { - "get": { - "tags": [ - "Group" - ], - "operationId": "WorkspaceGroup_ListByService", - "description": "Lists a collection of groups defined within a workspace in a service instance.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-groups" - }, - "x-ms-examples": { - "ApiManagementListWorkspaceGroups": { - "$ref": "./examples/ApiManagementListWorkspaceGroups.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| externalId | filter | eq | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Group entities.", - "schema": { - "$ref": "./definitions.json#/definitions/GroupCollection" - } - }, - "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-odata": "./definitions.json#/definitions/GroupContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}": { - "head": { - "tags": [ - "Group" - ], - "operationId": "WorkspaceGroup_GetEntityTag", - "description": "Gets the entity state (Etag) version of the group specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceGroup": { - "$ref": "./examples/ApiManagementHeadWorkspaceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified group entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Group" - ], - "operationId": "WorkspaceGroup_Get", - "description": "Gets the details of the group specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspaceGroup": { - "$ref": "./examples/ApiManagementGetWorkspaceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Group entity.", - "schema": { - "$ref": "./definitions.json#/definitions/GroupContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Group" - ], - "operationId": "WorkspaceGroup_CreateOrUpdate", - "description": "Creates or Updates a group.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceGroup": { - "$ref": "./examples/ApiManagementCreateWorkspaceGroup.json" - }, - "ApiManagementCreateWorkspaceGroupExternal": { - "$ref": "./examples/ApiManagementCreateWorkspaceGroupExternal.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/GroupCreateParameters" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Group was created successfully.", - "schema": { - "$ref": "./definitions.json#/definitions/GroupContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Group already exists.", - "schema": { - "$ref": "./definitions.json#/definitions/GroupContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Group" - ], - "operationId": "WorkspaceGroup_Update", - "description": "Updates the details of the group specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateWorkspaceGroup": { - "$ref": "./examples/ApiManagementUpdateWorkspaceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/GroupUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The group details were successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/GroupContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Group" - ], - "operationId": "WorkspaceGroup_Delete", - "description": "Deletes specific group of the workspace in an API Management service instance.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceGroup": { - "$ref": "./examples/ApiManagementDeleteWorkspaceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The group was successfully deleted." - }, - "204": { - "description": "The group was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users": { - "get": { - "tags": [ - "GroupUser" - ], - "operationId": "WorkspaceGroupUser_List", - "description": "Lists a collection of user entities associated with the group.", - "x-ms-examples": { - "ApiManagementListWorkspaceGroupUsers": { - "$ref": "./examples/ApiManagementListWorkspaceGroupUsers.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of user entities associated with the group.", - "schema": { - "$ref": "./definitions.json#/definitions/UserCollection" - } - }, - "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-odata": "./definitions.json#/definitions/UserContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users/{userId}": { - "head": { - "tags": [ - "GroupUser" - ], - "operationId": "WorkspaceGroupUser_CheckEntityExists", - "description": "Checks that user entity specified by identifier is associated with the group entity.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceGroupUser": { - "$ref": "./examples/ApiManagementHeadWorkspaceGroupUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "Entity exists" - }, - "404": { - "description": "Entity does not exists." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "GroupUser" - ], - "operationId": "WorkspaceGroupUser_Create", - "description": "Add existing user to existing group", - "x-ms-examples": { - "ApiManagementCreateWorkspaceGroupUser": { - "$ref": "./examples/ApiManagementCreateWorkspaceGroupUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "The user was successfully added to the group.", - "schema": { - "$ref": "./definitions.json#/definitions/UserContract" - } - }, - "200": { - "description": "The specified user is already a member of the specified group.", - "schema": { - "$ref": "./definitions.json#/definitions/UserContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "GroupUser" - ], - "operationId": "WorkspaceGroupUser_Delete", - "description": "Remove existing user from existing group.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceGroupUser": { - "$ref": "./examples/ApiManagementDeleteWorkspaceGroupUser.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/GroupIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/UserIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The user was successfully removed from the group." - }, - "204": { - "description": "The user was successfully removed from the group." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions": { - "get": { - "tags": [ - "Subscription" - ], - "operationId": "WorkspaceSubscription_List", - "description": "Lists all subscriptions of the workspace in an API Management service instance.", - "x-ms-examples": { - "ApiManagementListWorkspaceSubscriptions": { - "$ref": "./examples/ApiManagementListWorkspaceSubscriptions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A collection of the Subscription entities for the specified workspace in an API Management service instance.", - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionCollection" - } - }, - "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-odata": "./definitions.json#/definitions/SubscriptionContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}": { - "head": { - "tags": [ - "Subscription" - ], - "operationId": "WorkspaceSubscription_GetEntityTag", - "description": "Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceSubscription": { - "$ref": "./examples/ApiManagementHeadWorkspaceSubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified apimanagement subscription entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Subscription" - ], - "operationId": "WorkspaceSubscription_Get", - "description": "Gets the specified Subscription entity.", - "x-ms-examples": { - "ApiManagementGetWorkspaceSubscription": { - "$ref": "./examples/ApiManagementGetWorkspaceSubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Subscription entity.", - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Subscription" - ], - "operationId": "WorkspaceSubscription_CreateOrUpdate", - "description": "Creates or updates the subscription of specified user to the specified product.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceSubscription": { - "$ref": "./examples/ApiManagementCreateWorkspaceSubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionCreateParameters" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/NotifySubscriptionStateChangeParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AppTypeParameter" - } - ], - "responses": { - "201": { - "description": "The user was successfully subscribed to the product.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionContract" - } - }, - "200": { - "description": "The user already subscribed to the product.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Subscription" - ], - "operationId": "WorkspaceSubscription_Update", - "description": "Updates the details of a subscription specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateWorkspaceSubscription": { - "$ref": "./examples/ApiManagementUpdateWorkspaceSubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/NotifySubscriptionStateChangeParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/AppTypeParameter" - } - ], - "responses": { - "200": { - "description": "The subscription details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Subscription" - ], - "operationId": "WorkspaceSubscription_Delete", - "description": "Deletes the specified subscription.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceSubscription": { - "$ref": "./examples/ApiManagementDeleteWorkspaceSubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The subscription details were successfully deleted." - }, - "204": { - "description": "The subscription details were successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/regeneratePrimaryKey": { - "post": { - "tags": [ - "Subscription" - ], - "operationId": "WorkspaceSubscription_RegeneratePrimaryKey", - "description": "Regenerates primary key of existing subscription of the workspace in an API Management service instance.", - "x-ms-examples": { - "ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey": { - "$ref": "./examples/ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "The primary key was successfully regenerated." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/regenerateSecondaryKey": { - "post": { - "tags": [ - "Subscription" - ], - "operationId": "WorkspaceSubscription_RegenerateSecondaryKey", - "description": "Regenerates secondary key of existing subscription of the workspace in an API Management service instance.", - "x-ms-examples": { - "ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey": { - "$ref": "./examples/ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "The secondary key was successfully regenerated." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/listSecrets": { - "post": { - "tags": [ - "Subscription" - ], - "operationId": "WorkspaceSubscription_ListSecrets", - "description": "Gets the specified Subscription keys.", - "x-ms-examples": { - "ApiManagementWorkspaceSubscriptionListSecrets": { - "$ref": "./examples/ApiManagementWorkspaceSubscriptionListSecrets.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionEntityIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains subscription keys.", - "schema": { - "$ref": "./definitions.json#/definitions/SubscriptionKeysContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets": { - "get": { - "tags": [ - "ApiVersionSet" - ], - "operationId": "WorkspaceApiVersionSet_ListByService", - "description": "Lists a collection of API Version Sets in the specified workspace with a service instance.", - "x-ms-examples": { - "ApiManagementListWorkspaceApiVersionSets": { - "$ref": "./examples/ApiManagementListWorkspaceApiVersionSets.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Api Version Set entities.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiVersionSetCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ApiVersionSetContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}": { - "head": { - "tags": [ - "ApiVersionSet" - ], - "operationId": "WorkspaceApiVersionSet_GetEntityTag", - "description": "Gets the entity state (Etag) version of the Api Version Set specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceApiVersionSet": { - "$ref": "./examples/ApiManagementHeadWorkspaceApiVersionSet.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified Api Version Set entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiVersionSet" - ], - "operationId": "WorkspaceApiVersionSet_Get", - "description": "Gets the details of the Api Version Set specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspaceApiVersionSet": { - "$ref": "./examples/ApiManagementGetWorkspaceApiVersionSet.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the specified Api Version Set entity.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiVersionSetContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiVersionSet" - ], - "operationId": "WorkspaceApiVersionSet_CreateOrUpdate", - "description": "Creates or Updates a Api Version Set.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceApiVersionSet": { - "$ref": "./examples/ApiManagementCreateWorkspaceApiVersionSet.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ApiVersionSetContract" - }, - "description": "Create or update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Api Version Set was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiVersionSetContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Api Version Set was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiVersionSetContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "ApiVersionSet" - ], - "operationId": "WorkspaceApiVersionSet_Update", - "description": "Updates the details of the Api VersionSet specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateWorkspaceApiVersionSet": { - "$ref": "./examples/ApiManagementUpdateWorkspaceApiVersionSet.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ApiVersionSetUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Api Version Set was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiVersionSetContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiVersionSets" - ], - "operationId": "WorkspaceApiVersionSet_Delete", - "description": "Deletes specific Api Version Set.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceApiVersionSet": { - "$ref": "./examples/ApiManagementDeleteWorkspaceApiVersionSet.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionSetIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The ApiVersion Set details were successfully deleted." - }, - "204": { - "description": "The ApiVersion Set details were successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis": { - "get": { - "tags": [ - "Api" - ], - "operationId": "WorkspaceApi_ListByService", - "description": "Lists all APIs of the workspace in an API Management service instance.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-apis" - }, - "x-ms-examples": { - "ApiManagementListWorkspaceApis": { - "$ref": "./examples/ApiManagementListWorkspaceApis.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq, ne | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "tags", - "in": "query", - "required": false, - "type": "string", - "description": "Include tags in the response." - }, - { - "name": "expandApiVersionSet", - "in": "query", - "required": false, - "type": "boolean", - "description": "Include full ApiVersionSet resource in response" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Paged Result response of Apis.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ApiContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}": { - "head": { - "tags": [ - "Api" - ], - "operationId": "WorkspaceApi_GetEntityTag", - "description": "Gets the entity state (Etag) version of the API specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceApi": { - "$ref": "./examples/ApiManagementHeadWorkspaceApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified API entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Api" - ], - "operationId": "WorkspaceApi_Get", - "description": "Gets the details of the API specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspaceApiContract": { - "$ref": "./examples/ApiManagementGetWorkspaceApiContract.json" - }, - "ApiManagementGetWorkspaceApiRevision": { - "$ref": "./examples/ApiManagementGetWorkspaceApiRevision.json" - } - }, - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified API entity.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Api" - ], - "operationId": "WorkspaceApi_CreateOrUpdate", - "description": "Creates new or updates existing specified API of the workspace in an API Management service instance.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceApi": { - "$ref": "./examples/ApiManagementCreateWorkspaceApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ApiCreateOrUpdateParameter" - }, - "description": "Create or update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "API was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "200": { - "description": "API was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "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" - } - }, - "patch": { - "tags": [ - "Api" - ], - "operationId": "WorkspaceApi_Update", - "description": "Updates the specified API of the workspace in an API Management service instance.", - "x-ms-examples": { - "ApiManagementUpdateWorkspaceApi": { - "$ref": "./examples/ApiManagementUpdateWorkspaceApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ApiUpdateContract" - }, - "description": "API Update Contract parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "API was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Api" - ], - "operationId": "WorkspaceApi_Delete", - "description": "Deletes the specified API of the workspace in an API Management service instance.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceApi": { - "$ref": "./examples/ApiManagementDeleteWorkspaceApi.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "deleteRevisions", - "in": "query", - "required": false, - "type": "boolean", - "description": "Delete all revisions of the Api." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The API was successfully deleted." - }, - "204": { - "description": "The API was successfully deleted." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/revisions": { - "get": { - "tags": [ - "ApiRevision" - ], - "operationId": "WorkspaceApiRevision_ListByService", - "description": "Lists all revisions of an API.", - "x-ms-examples": { - "ApiManagementListWorkspaceApiRevisions": { - "$ref": "./examples/ApiManagementListWorkspaceApiRevisions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a list of revision details.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiRevisionCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ApiRevisionContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases": { - "get": { - "tags": [ - "ApiRelease" - ], - "operationId": "WorkspaceApiRelease_ListByService", - "description": "Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.", - "x-ms-examples": { - "ApiManagementListWorkspaceApiReleases": { - "$ref": "./examples/ApiManagementListWorkspaceApiReleases.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| notes | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a list of API Releases.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiReleaseCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ApiReleaseContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}": { - "head": { - "tags": [ - "ApiRelease" - ], - "operationId": "WorkspaceApiRelease_GetEntityTag", - "description": "Returns the etag of an API release.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceApiRelease": { - "$ref": "./examples/ApiManagementHeadWorkspaceApiRelease.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the entity state (Etag) version of the api release as specified by its identifier.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiRelease" - ], - "operationId": "WorkspaceApiRelease_Get", - "description": "Returns the details of an API release.", - "x-ms-examples": { - "ApiManagementGetWorkspaceApiRelease": { - "$ref": "./examples/ApiManagementGetWorkspaceApiRelease.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns the details of an API Release.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiReleaseContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiRelease" - ], - "operationId": "WorkspaceApiRelease_CreateOrUpdate", - "description": "Creates a new Release for the API.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceApiRelease": { - "$ref": "./examples/ApiManagementCreateWorkspaceApiRelease.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ApiReleaseContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Release was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiReleaseContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Release was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiReleaseContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "ApiRelease" - ], - "operationId": "WorkspaceApiRelease_Update", - "description": "Updates the details of the release of the API specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateWorkspaceApiRelease": { - "$ref": "./examples/ApiManagementUpdateWorkspaceApiRelease.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ApiReleaseContract" - }, - "description": "API Release Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Release was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiReleaseContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiRelease" - ], - "operationId": "WorkspaceApiRelease_Delete", - "description": "Deletes the specified release in the API.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceApiRelease": { - "$ref": "./examples/ApiManagementDeleteWorkspaceApiRelease.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ReleaseIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "API release successfully removed" - }, - "204": { - "description": "API release successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations": { - "get": { - "tags": [ - "ApiOperation" - ], - "operationId": "WorkspaceApiOperation_ListByApi", - "description": "Lists a collection of the operations for the specified API.", - "x-ms-examples": { - "ApiManagementListWorkspaceApiOperations": { - "$ref": "./examples/ApiManagementListWorkspaceApiOperations.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "tags", - "in": "query", - "required": false, - "type": "string", - "description": "Include tags in the response." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A collection of operation summary entities at the API level.", - "schema": { - "$ref": "./definitions.json#/definitions/OperationCollection" - } - }, - "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-odata": "./definitions.json#/definitions/OperationContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}": { - "head": { - "tags": [ - "ApiOperation" - ], - "operationId": "WorkspaceApiOperation_GetEntityTag", - "description": "Gets the entity state (Etag) version of the API operation specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceApiOperation": { - "$ref": "./examples/ApiManagementHeadWorkspaceApiOperation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified API operation entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiOperation" - ], - "operationId": "WorkspaceApiOperation_Get", - "description": "Gets the details of the API Operation specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspaceApiOperation": { - "$ref": "./examples/ApiManagementGetWorkspaceApiOperation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Operation entity.", - "schema": { - "$ref": "./definitions.json#/definitions/OperationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiOperation" - ], - "operationId": "WorkspaceApiOperation_CreateOrUpdate", - "description": "Creates a new operation in the API or updates an existing one.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceApiOperation": { - "$ref": "./examples/ApiManagementCreateWorkspaceApiOperation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/OperationContract" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Operation was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/OperationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Operation was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/OperationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "ApiOperation" - ], - "operationId": "WorkspaceApiOperation_Update", - "description": "Updates the details of the operation in the API specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateWorkspaceApiOperation": { - "$ref": "./examples/ApiManagementUpdateWorkspaceApiOperation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/OperationUpdateContract" - }, - "description": "API Operation Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/OperationContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiOperation" - ], - "operationId": "WorkspaceApiOperation_Delete", - "description": "Deletes the specified operation in the API.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceApiOperation": { - "$ref": "./examples/ApiManagementDeleteWorkspaceApiOperation.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "API operation successfully removed" - }, - "204": { - "description": "API operation successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}/policies": { - "get": { - "tags": [ - "ApiOperationPolicy" - ], - "operationId": "WorkspaceApiOperationPolicy_ListByOperation", - "description": "Get the list of policy configuration at the API Operation level.", - "x-ms-examples": { - "ApiManagementListWorkspaceApiOperationPolicies": { - "$ref": "./examples/ApiManagementListWorkspaceApiOperationPolicies.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Api Operations Policy Collection.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyCollection" - } - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}/policies/{policyId}": { - "head": { - "tags": [ - "ApiOperationPolicy" - ], - "operationId": "WorkspaceApiOperationPolicy_GetEntityTag", - "description": "Gets the entity state (Etag) version of the API operation policy specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceApiOperationPolicy": { - "$ref": "./examples/ApiManagementHeadWorkspaceApiOperationPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified API operation policy entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiOperationPolicy" - ], - "operationId": "WorkspaceApiOperationPolicy_Get", - "description": "Get the policy configuration at the API Operation level.", - "x-ms-examples": { - "ApiManagementGetWorkspaceApiOperationPolicy": { - "$ref": "./examples/ApiManagementGetWorkspaceApiOperationPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Api Operation Policy information.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiOperationPolicy" - ], - "operationId": "WorkspaceApiOperationPolicy_CreateOrUpdate", - "description": "Creates or updates policy configuration for the API Operation level.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceApiOperationPolicy": { - "$ref": "./examples/ApiManagementCreateWorkspaceApiOperationPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "description": "The policy contents to apply." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Api Operation policy configuration was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Api Operation policy configuration of the tenant was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiOperationPolicy" - ], - "operationId": "WorkspaceApiOperationPolicy_Delete", - "description": "Deletes the policy configuration at the Api Operation.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceApiOperationPolicy": { - "$ref": "./examples/ApiManagementDeleteWorkspaceApiOperationPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Policy successfully removed" - }, - "204": { - "description": "Policy successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies": { - "get": { - "tags": [ - "ApiPolicy" - ], - "operationId": "WorkspaceApiPolicy_ListByApi", - "description": "Get the policy configuration at the API level.", - "x-ms-examples": { - "ApiManagementListWorkspaceApiPolicies": { - "$ref": "./examples/ApiManagementListWorkspaceApiPolicies.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Apis Policy Collection.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyCollection" - } - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}": { - "head": { - "tags": [ - "ApiPolicy" - ], - "operationId": "WorkspaceApiPolicy_GetEntityTag", - "description": "Gets the entity state (Etag) version of the API policy specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceApiPolicy": { - "$ref": "./examples/ApiManagementHeadWorkspaceApiPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified API Policy entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiPolicy" - ], - "operationId": "WorkspaceApiPolicy_Get", - "description": "Get the policy configuration at the API level.", - "x-ms-examples": { - "ApiManagementGetWorkspaceApiPolicy": { - "$ref": "./examples/ApiManagementGetWorkspaceApiPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Api Policy information.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiPolicy" - ], - "operationId": "WorkspaceApiPolicy_CreateOrUpdate", - "description": "Creates or updates policy configuration for the API.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceApiPolicy": { - "$ref": "./examples/ApiManagementCreateWorkspaceApiPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "description": "The policy contents to apply." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Api policy configuration was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Api policy configuration of the tenant was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiPolicy" - ], - "operationId": "WorkspaceApiPolicy_Delete", - "description": "Deletes the policy configuration at the Api.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceApiPolicy": { - "$ref": "./examples/ApiManagementDeleteWorkspaceApiPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the policy configuration at the API level." - }, - "204": { - "description": "Successfully deleted the policy configuration at the API level." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas": { - "get": { - "tags": [ - "ApiSchema" - ], - "operationId": "WorkspaceApiSchema_ListByApi", - "description": "Get the schema configuration at the API level.", - "x-ms-examples": { - "ApiManagementListWorkspaceApiSchemas": { - "$ref": "./examples/ApiManagementListWorkspaceApiSchemas.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Apis Schema Collection.", - "schema": { - "$ref": "./definitions.json#/definitions/SchemaCollection" - } - }, - "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-odata": "./definitions.json#/definitions/SchemaContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas/{schemaId}": { - "head": { - "tags": [ - "ApiSchema" - ], - "operationId": "WorkspaceApiSchema_GetEntityTag", - "description": "Gets the entity state (Etag) version of the schema specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceApiSchema": { - "$ref": "./examples/ApiManagementHeadWorkspaceApiSchema.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified schema entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiSchema" - ], - "operationId": "WorkspaceApiSchema_Get", - "description": "Get the schema configuration at the API level.", - "x-ms-examples": { - "ApiManagementGetWorkspaceApiSchema": { - "$ref": "./examples/ApiManagementGetWorkspaceApiSchema.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Api Schema information.", - "schema": { - "$ref": "./definitions.json#/definitions/SchemaContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiSchema" - ], - "operationId": "WorkspaceApiSchema_CreateOrUpdate", - "description": "Creates or updates schema configuration for the API.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceApiSchema": { - "$ref": "./examples/ApiManagementCreateWorkspaceApiSchema.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/SchemaContract" - }, - "description": "The schema contents to apply." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Api schema configuration was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/SchemaContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "type": "string" - } - } - }, - "200": { - "description": "Api schema configuration of the tenant was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/SchemaContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - }, - "location": { - "description": "Location header contains the URL where the status of the long running operation can be checked", - "type": "string" - }, - "Azure-AsyncOperation": { - "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked", - "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" - } - }, - "delete": { - "tags": [ - "ApiSchema" - ], - "operationId": "WorkspaceApiSchema_Delete", - "description": "Deletes the schema configuration at the Api.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceApiSchema": { - "$ref": "./examples/ApiManagementDeleteWorkspaceApiSchema.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SchemaIdParameter" - }, - { - "name": "force", - "in": "query", - "required": false, - "type": "boolean", - "description": "If true removes all references to the schema before deleting it." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the schema configuration at the API level." - }, - "204": { - "description": "Successfully deleted the schema configuration at the API level." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products": { - "get": { - "tags": [ - "Product" - ], - "operationId": "WorkspaceProduct_ListByService", - "description": "Lists a collection of products in the specified workspace in a service instance.", - "x-ms-examples": { - "ApiManagementListWorkspaceProducts": { - "$ref": "./examples/ApiManagementListWorkspaceProducts.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| groups | expand | | |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "expandGroups", - "in": "query", - "required": false, - "type": "boolean", - "description": "When set to true, the response contains an array of groups that have visibility to the product. The default is false." - }, - { - "name": "tags", - "in": "query", - "required": false, - "type": "string", - "description": "Products which are part of a specific tag." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A Collection of the Product entities for the specified workspace in an API Management service instance.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ProductContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}": { - "head": { - "tags": [ - "Product" - ], - "operationId": "WorkspaceProduct_GetEntityTag", - "description": "Gets the entity state (Etag) version of the product specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceProduct": { - "$ref": "./examples/ApiManagementHeadWorkspaceProduct.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified Product entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Product" - ], - "operationId": "WorkspaceProduct_Get", - "description": "Gets the details of the product specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspaceProduct": { - "$ref": "./examples/ApiManagementGetWorkspaceProduct.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Product entity.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Product" - ], - "operationId": "WorkspaceProduct_CreateOrUpdate", - "description": "Creates or Updates a product.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceProduct": { - "$ref": "./examples/ApiManagementCreateWorkspaceProduct.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ProductContract" - }, - "description": "Create or update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Product was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Product was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Product" - ], - "operationId": "WorkspaceProduct_Update", - "description": "Update existing product details.", - "x-ms-examples": { - "ApiManagementUpdateWorkspaceProduct": { - "$ref": "./examples/ApiManagementUpdateWorkspaceProduct.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ProductUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Product was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Product" - ], - "operationId": "WorkspaceProduct_Delete", - "description": "Delete product.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceProduct": { - "$ref": "./examples/ApiManagementDeleteWorkspaceProduct.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "name": "deleteSubscriptions", - "in": "query", - "required": false, - "type": "boolean", - "description": "Delete existing subscriptions associated with the product or not." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Product was successfully removed." - }, - "204": { - "description": "Product was successfully removed by previous request or does not exist." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/apiLinks": { - "get": { - "tags": [ - "ProductApiLink" - ], - "operationId": "WorkspaceProductApiLink_ListByProduct", - "description": "Lists a collection of the API links associated with a product.", - "x-ms-examples": { - "ApiManagementListWorkspaceProductApiLinks": { - "$ref": "./examples/ApiManagementListWorkspaceProductApiLinks.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains a collection of API link entities in the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductApiLinkCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ProductApiLinkContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/apiLinks/{apiLinkId}": { - "get": { - "tags": [ - "ProductApiLink" - ], - "operationId": "WorkspaceProductApiLink_Get", - "description": "Gets the API link for the product.", - "x-ms-examples": { - "ApiManagementGetWorkspaceProductApiLink": { - "$ref": "./examples/ApiManagementGetWorkspaceProductApiLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductApiLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified API link entity.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductApiLinkContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ProductApiLink" - ], - "operationId": "WorkspaceProductApiLink_CreateOrUpdate", - "description": "Adds an API to the specified product via link.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceProductApiLink": { - "$ref": "./examples/ApiManagementCreateWorkspaceProductApiLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductApiLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ProductApiLinkContract" - }, - "description": "Create or update parameters." - } - ], - "responses": { - "201": { - "description": "The API was successfully added to the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductApiLinkContract" - } - }, - "200": { - "description": "The specified API is already added to the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductApiLinkContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ProductApiLink" - ], - "operationId": "WorkspaceProductApiLink_Delete", - "description": "Deletes the specified API from the specified product.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceProductApiLink": { - "$ref": "./examples/ApiManagementDeleteWorkspaceProductApiLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductApiLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "API was successfully removed from product" - }, - "204": { - "description": "API successfully removed by previous request or does not exist in product" - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/groupLinks": { - "get": { - "tags": [ - "ProductGroupLink" - ], - "operationId": "WorkspaceProductGroupLink_ListByProduct", - "description": "Lists a collection of the group links associated with a product.", - "x-ms-examples": { - "ApiManagementListWorkspaceProductGroupLinks": { - "$ref": "./examples/ApiManagementListWorkspaceProductGroupLinks.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| groupId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains a collection of group link entities in the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductGroupLinkCollection" - } - }, - "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-odata": "./definitions.json#/definitions/ProductGroupLinkContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/groupLinks/{groupLinkId}": { - "get": { - "tags": [ - "ProductGroupLink" - ], - "operationId": "WorkspaceProductGroupLink_Get", - "description": "Gets the group link for the product.", - "x-ms-examples": { - "ApiManagementGetWorkspaceProductGroupLink": { - "$ref": "./examples/ApiManagementGetWorkspaceProductGroupLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductGroupLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified group link entity.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ProductGroupLink" - ], - "operationId": "WorkspaceProductGroupLink_CreateOrUpdate", - "description": "Adds a group to the specified product via link.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceProductGroupLink": { - "$ref": "./examples/ApiManagementCreateWorkspaceProductGroupLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductGroupLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" - }, - "description": "Create or update parameters." - } - ], - "responses": { - "201": { - "description": "The group was successfully added to the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" - } - }, - "200": { - "description": "The specified group is already added to the product.", - "schema": { - "$ref": "./definitions.json#/definitions/ProductGroupLinkContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ProductGroupLink" - ], - "operationId": "WorkspaceProductGroupLink_Delete", - "description": "Deletes the specified group from the specified product.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceProductGroupLink": { - "$ref": "./examples/ApiManagementDeleteWorkspaceProductGroupLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductGroupLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Group was successfully removed from product" - }, - "204": { - "description": "Group successfully removed by previous request or does not exist in product" - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/policies": { - "get": { - "tags": [ - "ProductPolicy" - ], - "operationId": "WorkspaceProductPolicy_ListByProduct", - "description": "Get the policy configuration at the Product level.", - "x-ms-examples": { - "ApiManagementListWorkspaceProductPolicies": { - "$ref": "./examples/ApiManagementListWorkspaceProductPolicies.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Product Policy information.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyCollection" - } - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/policies/{policyId}": { - "head": { - "tags": [ - "ProductPolicy" - ], - "operationId": "WorkspaceProductPolicy_GetEntityTag", - "description": "Get the ETag of the policy configuration at the Product level.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceProductPolicy": { - "$ref": "./examples/ApiManagementHeadWorkspaceProductPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Product Policy Etag information.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ProductPolicy" - ], - "operationId": "WorkspaceProductPolicy_Get", - "description": "Get the policy configuration at the Product level.", - "x-ms-examples": { - "ApiManagementGetWorkspaceProductPolicy": { - "$ref": "./examples/ApiManagementGetWorkspaceProductPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyExportFormat" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Product Policy information.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ProductPolicy" - ], - "operationId": "WorkspaceProductPolicy_CreateOrUpdate", - "description": "Creates or updates policy configuration for the Product.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceProductPolicy": { - "$ref": "./examples/ApiManagementCreateWorkspaceProductPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "description": "The policy contents to apply." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Product policy configuration was successfully created.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "200": { - "description": "Product policy configuration of the tenant was successfully updated.", - "schema": { - "$ref": "./definitions.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ProductPolicy" - ], - "operationId": "WorkspaceProductPolicy_Delete", - "description": "Deletes the policy configuration at the Product.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceProductPolicy": { - "$ref": "./examples/ApiManagementDeleteWorkspaceProductPolicy.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ProductIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the policy configuration at the Product level." - }, - "204": { - "description": "Successfully deleted the policy configuration at the Product level." - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags": { - "get": { - "tags": [ - "Tag" - ], - "operationId": "WorkspaceTag_ListByService", - "description": "Lists a collection of tags defined within a workspace in a service instance.", - "x-ms-examples": { - "ApiManagementListWorkspaceTags": { - "$ref": "./examples/ApiManagementListWorkspaceTags.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "name": "scope", - "in": "query", - "required": false, - "type": "string", - "description": "Scope like 'apis', 'products' or 'apis/{apiId}" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists a collection of Tag entities.", - "schema": { - "$ref": "./definitions.json#/definitions/TagCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}": { - "head": { - "tags": [ - "Tag" - ], - "operationId": "WorkspaceTag_GetEntityState", - "description": "Gets the entity state version of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadWorkspaceTag": { - "$ref": "./examples/ApiManagementHeadWorkspaceTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Empty response body, ETag header entity state version.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Tag" - ], - "operationId": "WorkspaceTag_Get", - "description": "Gets the details of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementGetWorkspaceTag": { - "$ref": "./examples/ApiManagementGetWorkspaceTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified Tag entity.", - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Tag" - ], - "operationId": "WorkspaceTag_CreateOrUpdate", - "description": "Creates a tag.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceTag": { - "$ref": "./examples/ApiManagementCreateWorkspaceTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/TagCreateUpdateParameters" - }, - "description": "Create parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Tag was created successfully.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - } - }, - "200": { - "description": "Tag already exists.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Tag" - ], - "operationId": "WorkspaceTag_Update", - "description": "Updates the details of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementUpdateWorkspaceTag": { - "$ref": "./examples/ApiManagementUpdateWorkspaceTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/TagCreateUpdateParameters" - }, - "description": "Update parameters." - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The tag details were successfully updated.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - }, - "schema": { - "$ref": "./definitions.json#/definitions/TagContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Tag" - ], - "operationId": "WorkspaceTag_Delete", - "description": "Deletes specific tag of the workspace in an API Management service instance.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceTag": { - "$ref": "./examples/ApiManagementDeleteWorkspaceTag.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Tag successfully removed" - }, - "204": { - "description": "Tag successfully removed by previous request or does not exist" - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/apiLinks": { - "get": { - "tags": [ - "TagApiLink" - ], - "operationId": "WorkspaceTagApiLink_ListByProduct", - "description": "Lists a collection of the API links associated with a tag.", - "x-ms-examples": { - "ApiManagementListWorkspaceTagApiLinks": { - "$ref": "./examples/ApiManagementListWorkspaceTagApiLinks.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains a collection of API link entities associated with a tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagApiLinkCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagApiLinkContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/apiLinks/{apiLinkId}": { - "get": { - "tags": [ - "TagApiLink" - ], - "operationId": "WorkspaceTagApiLink_Get", - "description": "Gets the API link for the tag.", - "x-ms-examples": { - "ApiManagementGetWorkspaceTagApiLink": { - "$ref": "./examples/ApiManagementGetWorkspaceTagApiLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagApiLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified API link entity.", - "schema": { - "$ref": "./definitions.json#/definitions/TagApiLinkContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "TagApiLink" - ], - "operationId": "WorkspaceTagApiLink_CreateOrUpdate", - "description": "Adds an API to the specified tag via link.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceTagApiLink": { - "$ref": "./examples/ApiManagementCreateWorkspaceTagApiLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagApiLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/TagApiLinkContract" - }, - "description": "Create or update parameters." - } - ], - "responses": { - "201": { - "description": "The API was successfully added to the tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagApiLinkContract" - } - }, - "200": { - "description": "The specified API is already added to the tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagApiLinkContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "TagApiLink" - ], - "operationId": "WorkspaceTagApiLink_Delete", - "description": "Deletes the specified API from the specified tag.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceTagApiLink": { - "$ref": "./examples/ApiManagementDeleteWorkspaceTagApiLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagApiLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "API was successfully removed from tag" - }, - "204": { - "description": "API successfully removed by previous request or does not exist in tag" - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/operationLinks": { - "get": { - "tags": [ - "TagOperationLink" - ], - "operationId": "WorkspaceTagOperationLink_ListByProduct", - "description": "Lists a collection of the operation links associated with a tag.", - "x-ms-examples": { - "ApiManagementListWorkspaceTagOperationLinks": { - "$ref": "./examples/ApiManagementListWorkspaceTagOperationLinks.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| operationId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains a collection of operation link entities associated with a tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagOperationLinkCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagOperationLinkContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/operationLinks/{operationLinkId}": { - "get": { - "tags": [ - "TagOperationLink" - ], - "operationId": "WorkspaceTagOperationLink_Get", - "description": "Gets the operation link for the tag.", - "x-ms-examples": { - "ApiManagementGetWorkspaceTagOperationLink": { - "$ref": "./examples/ApiManagementGetWorkspaceTagOperationLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagOperationLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified operation link entity.", - "schema": { - "$ref": "./definitions.json#/definitions/TagOperationLinkContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "TagOperationLink" - ], - "operationId": "WorkspaceTagOperationLink_CreateOrUpdate", - "description": "Adds an operation to the specified tag via link.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceTagOperationLink": { - "$ref": "./examples/ApiManagementCreateWorkspaceTagOperationLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagOperationLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/TagOperationLinkContract" - }, - "description": "Create or update parameters." - } - ], - "responses": { - "201": { - "description": "The operation was successfully added to the tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagOperationLinkContract" - } - }, - "200": { - "description": "The specified operation is already added to the tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagOperationLinkContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "TagOperationLink" - ], - "operationId": "WorkspaceTagOperationLink_Delete", - "description": "Deletes the specified operation from the specified tag.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceTagOperationLink": { - "$ref": "./examples/ApiManagementDeleteWorkspaceTagOperationLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagOperationLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Operation was successfully removed from tag" - }, - "204": { - "description": "Operation successfully removed by previous request or does not exist in tag" - }, - "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.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/productLinks": { - "get": { - "tags": [ - "TagProductLink" - ], - "operationId": "WorkspaceTagProductLink_ListByProduct", - "description": "Lists a collection of the product links associated with a tag.", - "x-ms-examples": { - "ApiManagementListWorkspaceTagProductLinks": { - "$ref": "./examples/ApiManagementListWorkspaceTagProductLinks.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains a collection of product link entities associated with a tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagProductLinkCollection" - } - }, - "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-odata": "./definitions.json#/definitions/TagProductLinkContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/productLinks/{productLinkId}": { - "get": { - "tags": [ - "TagProductLink" - ], - "operationId": "WorkspaceTagProductLink_Get", - "description": "Gets the product link for the tag.", - "x-ms-examples": { - "ApiManagementGetWorkspaceTagProductLink": { - "$ref": "./examples/ApiManagementGetWorkspaceTagProductLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagProductLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response body contains the specified product link entity.", - "schema": { - "$ref": "./definitions.json#/definitions/TagProductLinkContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "TagProductLink" - ], - "operationId": "WorkspaceTagProductLink_CreateOrUpdate", - "description": "Adds a product to the specified tag via link.", - "x-ms-examples": { - "ApiManagementCreateWorkspaceTagProductLink": { - "$ref": "./examples/ApiManagementCreateWorkspaceTagProductLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagProductLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./definitions.json#/definitions/TagProductLinkContract" - }, - "description": "Create or update parameters." - } - ], - "responses": { - "201": { - "description": "The product was successfully added to the tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagProductLinkContract" - } - }, - "200": { - "description": "The specified product is already added to the tag.", - "schema": { - "$ref": "./definitions.json#/definitions/TagProductLinkContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "TagProductLink" - ], - "operationId": "WorkspaceTagProductLink_Delete", - "description": "Deletes the specified product from the specified tag.", - "x-ms-examples": { - "ApiManagementDeleteWorkspaceTagProductLink": { - "$ref": "./examples/ApiManagementDeleteWorkspaceTagProductLink.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/TagProductLinkIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Product was successfully removed from tag" - }, - "204": { - "description": "Product successfully removed by previous request or does not exist in tag" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "x-ms-paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}?export=true": { - "get": { - "tags": [ - "Apis" - ], - "operationId": "WorkspaceApiExport_Get", - "description": "Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.", - "x-ms-examples": { - "ApiManagementGetWorkspaceApiExportInOpenApi2dot0": { - "$ref": "./examples/ApiManagementGetWorkspaceApiExportInOpenApi2dot0.json" - }, - "ApiManagementGetWorkspaceApiExportInOpenApi3dot0": { - "$ref": "./examples/ApiManagementGetWorkspaceApiExportInOpenApi3dot0.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/WorkspaceIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter" - }, - { - "name": "format", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "swagger-link", - "wadl-link", - "wsdl-link", - "openapi-link", - "openapi+json-link" - ], - "x-ms-enum": { - "name": "ExportFormat", - "modelAsString": true, - "values": [ - { - "value": "swagger-link", - "description": "Export the Api Definition in OpenAPI 2.0 Specification as JSON document to the Storage Blob.", - "name": "Swagger" - }, - { - "value": "wsdl-link", - "description": "Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`", - "name": "Wsdl" - }, - { - "value": "wadl-link", - "description": "Export the Api Definition in WADL Schema to Storage Blob.", - "name": "Wadl" - }, - { - "value": "openapi-link", - "description": "Export the Api Definition in OpenAPI 3.0 Specification as YAML document to Storage Blob.", - "name": "Openapi" - }, - { - "value": "openapi+json-link", - "description": "Export the Api Definition in OpenAPI 3.0 Specification as JSON document to Storage Blob.", - "name": "OpenapiJson" - } - ] - }, - "description": "Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes." - }, - { - "name": "export", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "true" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "ExportApi" - }, - "description": "Query parameter required to export the API details." - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The response contains a stream with a full set of API metadata and includes API entity with an embedded array of operation entities.", - "schema": { - "$ref": "./definitions.json#/definitions/ApiExportResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": {}, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/definitions.json deleted file mode 100644 index 9aa603ed20ad..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/definitions.json +++ /dev/null @@ -1,9853 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2024-10-01-preview", - "description": "A spec file containing all the definitions", - "title": "Definitions file" - }, - "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": { - "AccessInformationCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AccessInformationContract" - }, - "description": "Page values.", - "readOnly": true - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged AccessInformation list representation." - }, - "AccessInformationContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AccessInformationContractProperties", - "description": "AccessInformation entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Tenant Settings." - }, - "AccessInformationContractProperties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Access Information type ('access' or 'gitAccess')" - }, - "principalId": { - "type": "string", - "description": "Principal (User) Identifier." - }, - "enabled": { - "type": "boolean", - "description": "Determines whether direct access is enabled." - } - }, - "description": "Tenant access information contract of the API Management service." - }, - "AccessInformationSecretsContract": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Access Information type ('access' or 'gitAccess')" - }, - "principalId": { - "type": "string", - "description": "Principal (User) Identifier." - }, - "primaryKey": { - "type": "string", - "x-ms-secret": true, - "description": "Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." - }, - "secondaryKey": { - "type": "string", - "x-ms-secret": true, - "description": "Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." - }, - "enabled": { - "type": "boolean", - "description": "Determines whether direct access is enabled." - } - }, - "description": "Tenant access information contract of the API Management service." - }, - "AccessInformationCreateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AccessInformationCreateParameterProperties", - "description": "Tenant access information update parameter properties." - } - }, - "description": "Tenant access information update parameters." - }, - "AccessInformationCreateParameterProperties": { - "type": "object", - "properties": { - "principalId": { - "type": "string", - "description": "Principal (User) Identifier." - }, - "primaryKey": { - "type": "string", - "x-ms-secret": true, - "description": "Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." - }, - "secondaryKey": { - "type": "string", - "x-ms-secret": true, - "description": "Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." - }, - "enabled": { - "type": "boolean", - "description": "Determines whether direct access is enabled." - } - }, - "description": "Tenant access information update parameters of the API Management service" - }, - "AccessInformationUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AccessInformationUpdateParameterProperties", - "description": "Tenant access information update parameter properties." - } - }, - "description": "Tenant access information update parameters." - }, - "AccessInformationUpdateParameterProperties": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Determines whether direct access is enabled." - } - }, - "description": "Tenant access information update parameters of the API Management service" - }, - "TenantSettingsCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TenantSettingsContract" - }, - "description": "Page values.", - "readOnly": true - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged AccessInformation list representation." - }, - "TenantSettingsContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/TenantSettingsContractProperties", - "description": "TenantSettings entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Tenant Settings." - }, - "TenantSettingsContractProperties": { - "type": "object", - "properties": { - "settings": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Tenant settings" - } - }, - "description": "Tenant access information contract of the API Management service." - }, - "ApiCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiContract" - }, - "description": "Page values.", - "readOnly": true - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged API list representation." - }, - "DocumentationCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DocumentationContract" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "Page values.", - "readOnly": true - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Documentation list representation." - }, - "WikiCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/WikiContract" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "Page values.", - "readOnly": true - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Wiki list representation." - }, - "ApiContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiContractProperties", - "description": "API entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "API details." - }, - "ApiContractProperties": { - "type": "object", - "properties": { - "sourceApiId": { - "type": "string", - "description": "API identifier of the source API." - }, - "displayName": { - "type": "string", - "description": "API name. Must be 1 to 300 characters long.", - "minLength": 1, - "maxLength": 300 - }, - "serviceUrl": { - "type": "string", - "description": "Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.", - "minLength": 0, - "maxLength": 2000 - }, - "path": { - "type": "string", - "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.", - "minLength": 0, - "maxLength": 400 - }, - "protocols": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ], - "x-ms-enum": { - "name": "Protocol", - "modelAsString": true - } - }, - "description": "Describes on which protocols the operations in this API can be invoked." - }, - "apiVersionSet": { - "description": "Version set details", - "$ref": "#/definitions/ApiVersionSetContractDetails" - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "The provisioning state" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ApiEntityBaseContract" - } - ], - "required": [ - "path" - ], - "description": "API Entity Properties" - }, - "ApiCreateOrUpdateParameter": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiCreateOrUpdateProperties", - "description": "API entity create of update properties." - } - }, - "description": "API Create or Update Parameters." - }, - "ApiCreateOrUpdateProperties": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "Content value when Importing an API." - }, - "format": { - "type": "string", - "description": "Format of the Content in which the API is getting imported. New formats can be added in the future", - "enum": [ - "wadl-xml", - "wadl-link-json", - "swagger-json", - "swagger-link-json", - "wsdl", - "wsdl-link", - "openapi", - "openapi+json", - "openapi-link", - "openapi+json-link", - "graphql-link", - "odata", - "odata-link", - "grpc", - "grpc-link" - ], - "x-ms-enum": { - "name": "ContentFormat", - "modelAsString": true, - "values": [ - { - "value": "wadl-xml", - "description": "The contents are inline and Content type is a WADL document." - }, - { - "value": "wadl-link-json", - "description": "The WADL document is hosted on a publicly accessible internet address." - }, - { - "value": "swagger-json", - "description": "The contents are inline and Content Type is a OpenAPI 2.0 JSON Document." - }, - { - "value": "swagger-link-json", - "description": "The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address." - }, - { - "value": "wsdl", - "description": "The contents are inline and the document is a WSDL/Soap document." - }, - { - "value": "wsdl-link", - "description": "The WSDL document is hosted on a publicly accessible internet address." - }, - { - "value": "openapi", - "description": "The contents are inline and Content Type is a OpenAPI 3.0 YAML Document." - }, - { - "value": "openapi+json", - "description": "The contents are inline and Content Type is a OpenAPI 3.0 JSON Document." - }, - { - "value": "openapi-link", - "description": "The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address." - }, - { - "value": "openapi+json-link", - "description": "The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address." - }, - { - "value": "graphql-link", - "description": "The GraphQL API endpoint hosted on a publicly accessible internet address." - }, - { - "value": "odata", - "description": "The contents are inline and Content Type is a OData XML Document." - }, - { - "value": "odata-link", - "description": "The OData metadata document hosted on a publicly accessible internet address." - }, - { - "value": "grpc", - "description": "The contents are inline and Content Type is a gRPC protobuf file." - }, - { - "value": "grpc-link", - "description": "The gRPC protobuf file is hosted on a publicly accessible internet address." - } - ] - } - }, - "wsdlSelector": { - "type": "object", - "description": "Criteria to limit import of WSDL to a subset of the document.", - "properties": { - "wsdlServiceName": { - "type": "string", - "description": "Name of service to import from WSDL" - }, - "wsdlEndpointName": { - "type": "string", - "description": "Name of endpoint(port) to import from WSDL" - } - } - }, - "apiType": { - "type": "string", - "description": "Type of API to create. \n * `http` creates a REST API \n * `soap` creates a SOAP pass-through API \n * `websocket` creates websocket API \n * `graphql` creates GraphQL API. \n New types can be added in the future.", - "enum": [ - "http", - "soap", - "websocket", - "graphql", - "odata", - "grpc" - ], - "x-ms-client-name": "SoapApiType", - "x-ms-enum": { - "name": "SoapApiType", - "modelAsString": true, - "values": [ - { - "value": "http", - "description": "Imports a SOAP API having a RESTful front end.", - "name": "SoapToRest" - }, - { - "value": "soap", - "description": "Imports the SOAP API having a SOAP front end.", - "name": "SoapPassThrough" - }, - { - "value": "websocket", - "description": "Imports the API having a Websocket front end.", - "name": "WebSocket" - }, - { - "value": "graphql", - "description": "Imports the API having a GraphQL front end.", - "name": "GraphQL" - }, - { - "value": "odata", - "description": "Imports the API having a OData front end.", - "name": "OData" - }, - { - "value": "grpc", - "description": "Imports the API having a gRPC front end.", - "name": "gRPC" - } - ] - } - }, - "translateRequiredQueryParameters": { - "type": "string", - "description": "Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'", - "enum": [ - "template", - "query" - ], - "x-ms-client-name": "TranslateRequiredQueryParametersConduct", - "x-ms-enum": { - "name": "TranslateRequiredQueryParametersConduct", - "modelAsString": true, - "values": [ - { - "value": "template", - "description": "Translates required query parameters to template ones. Is a default value", - "name": "Template" - }, - { - "value": "query", - "description": "Leaves required query parameters as they are (no translation done).", - "name": "Query" - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/ApiContractProperties" - } - ], - "description": "API Create or Update Properties." - }, - "ApiEntityBaseContract": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the API. May include HTML formatting tags." - }, - "authenticationSettings": { - "$ref": "#/definitions/AuthenticationSettingsContract", - "description": "Collection of authentication settings included into this API." - }, - "subscriptionKeyParameterNames": { - "$ref": "#/definitions/SubscriptionKeyParameterNamesContract", - "description": "Protocols over which API is made available." - }, - "type": { - "type": "string", - "description": "Type of API.", - "enum": [ - "http", - "soap", - "websocket", - "graphql", - "odata", - "grpc" - ], - "x-ms-client-name": "ApiType", - "x-ms-enum": { - "name": "ApiType", - "modelAsString": true - } - }, - "apiRevision": { - "type": "string", - "description": "Describes the revision of the API. If no value is provided, default revision 1 is created", - "minLength": 1, - "maxLength": 100 - }, - "apiVersion": { - "type": "string", - "description": "Indicates the version identifier of the API if the API is versioned", - "maxLength": 100 - }, - "isCurrent": { - "type": "boolean", - "description": "Indicates if API revision is current api revision." - }, - "isOnline": { - "type": "boolean", - "description": "Indicates if API revision is accessible via the gateway.", - "readOnly": true - }, - "apiRevisionDescription": { - "type": "string", - "description": "Description of the API Revision.", - "maxLength": 256 - }, - "apiVersionDescription": { - "type": "string", - "description": "Description of the API Version.", - "maxLength": 256 - }, - "apiVersionSetId": { - "type": "string", - "description": "A resource identifier for the related ApiVersionSet." - }, - "subscriptionRequired": { - "type": "boolean", - "description": "Specifies whether an API or Product subscription is required for accessing the API." - }, - "termsOfServiceUrl": { - "type": "string", - "description": " A URL to the Terms of Service for the API. MUST be in the format of a URL." - }, - "contact": { - "$ref": "#/definitions/ApiContactInformation", - "description": "Contact information for the API." - }, - "license": { - "$ref": "#/definitions/ApiLicenseInformation", - "description": "License information for the API." - } - }, - "description": "API base contract details." - }, - "ApiContactInformation": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The identifying name of the contact person/organization" - }, - "url": { - "type": "string", - "description": "The URL pointing to the contact information. MUST be in the format of a URL" - }, - "email": { - "type": "string", - "description": "The email address of the contact person/organization. MUST be in the format of an email address" - } - }, - "description": "API contact information" - }, - "ApiLicenseInformation": { - "type": "object", - "description": "API license information", - "properties": { - "name": { - "type": "string", - "description": "The license name used for the API" - }, - "url": { - "type": "string", - "description": "A URL to the license used for the API. MUST be in the format of a URL" - } - } - }, - "ApiExportResult": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ResourceId of the API which was exported." - }, - "format": { - "type": "string", - "enum": [ - "swagger-link-json", - "wadl-link-json", - "wsdl-link+xml", - "openapi-link" - ], - "x-ms-client-name": "ExportResultFormat", - "x-ms-enum": { - "name": "ExportResultFormat", - "modelAsString": true, - "values": [ - { - "value": "swagger-link-json", - "description": "The API Definition is exported in OpenAPI Specification 2.0 format to the Storage Blob.", - "name": "Swagger" - }, - { - "value": "wsdl-link+xml", - "description": "The API Definition is exported in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`", - "name": "Wsdl" - }, - { - "value": "wadl-link-json", - "description": "Export the API Definition in WADL Schema to Storage Blob.", - "name": "Wadl" - }, - { - "value": "openapi-link", - "description": "Export the API Definition in OpenAPI Specification 3.0 to Storage Blob.", - "name": "OpenApi" - } - ] - }, - "description": "Format in which the API Details are exported to the Storage Blob with Sas Key valid for 5 minutes." - }, - "value": { - "type": "object", - "description": "The object defining the schema of the exported API Detail", - "properties": { - "link": { - "type": "string", - "description": "Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes." - } - } - } - }, - "description": "API Export result." - }, - "ApiReleaseCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiReleaseContract" - }, - "description": "Page values.", - "readOnly": true - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged ApiRelease list representation." - }, - "ApiReleaseContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiReleaseContractProperties", - "description": "ApiRelease entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "ApiRelease details." - }, - "ApiReleaseContractProperties": { - "type": "object", - "properties": { - "apiId": { - "type": "string", - "description": "Identifier of the API the release belongs to." - }, - "createdDateTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." - }, - "updatedDateTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "The time the API release was updated." - }, - "notes": { - "type": "string", - "description": "Release Notes" - } - }, - "description": "API Release details" - }, - "ApiRevisionCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiRevisionContract" - }, - "x-ms-identifiers": [ - "apiId" - ], - "description": "Page values.", - "readOnly": true - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged API Revision list representation." - }, - "ApiRevisionContract": { - "type": "object", - "properties": { - "apiId": { - "type": "string", - "readOnly": true, - "description": "Identifier of the API Revision." - }, - "apiRevision": { - "type": "string", - "minLength": 1, - "maxLength": 100, - "readOnly": true, - "description": "Revision number of API." - }, - "createdDateTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "The time the API Revision was created. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." - }, - "updatedDateTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "The time the API Revision were updated. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." - }, - "description": { - "type": "string", - "readOnly": true, - "maxLength": 256, - "description": "Description of the API Revision." - }, - "privateUrl": { - "type": "string", - "readOnly": true, - "description": "Gateway URL for accessing the non-current API Revision." - }, - "isOnline": { - "type": "boolean", - "readOnly": true, - "description": "Indicates if API revision is the current api revision." - }, - "isCurrent": { - "type": "boolean", - "readOnly": true, - "description": "Indicates if API revision is accessible via the gateway." - } - }, - "description": "Summary of revision metadata." - }, - "ApiRevisionInfoContract": { - "type": "object", - "description": "Object used to create an API Revision or Version based on an existing API Revision", - "properties": { - "sourceApiId": { - "type": "string", - "description": "Resource identifier of API to be used to create the revision from." - }, - "apiVersionName": { - "type": "string", - "maxLength": 100, - "description": "Version identifier for the new API Version." - }, - "apiRevisionDescription": { - "type": "string", - "maxLength": 256, - "description": "Description of new API Revision." - }, - "apiVersionSet": { - "description": "Version set details", - "$ref": "#/definitions/ApiVersionSetContractDetails" - } - } - }, - "ApiTagResourceContractProperties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "API identifier in the form /apis/{apiId}." - }, - "name": { - "type": "string", - "description": "API name.", - "minLength": 1, - "maxLength": 300 - }, - "serviceUrl": { - "type": "string", - "description": "Absolute URL of the backend service implementing this API.", - "minLength": 1, - "maxLength": 2000 - }, - "path": { - "type": "string", - "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.", - "minLength": 0, - "maxLength": 400 - }, - "protocols": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ], - "x-ms-enum": { - "name": "Protocol", - "modelAsString": true - } - }, - "description": "Describes on which protocols the operations in this API can be invoked." - } - }, - "allOf": [ - { - "$ref": "./definitions.json#/definitions/ApiEntityBaseContract" - } - ], - "description": "API contract properties for the Tag Resources." - }, - "ApiUpdateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiContractUpdateProperties", - "description": "Properties of the API entity that can be updated." - } - }, - "description": "API update contract details." - }, - "ApiContractUpdateProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "API name.", - "minLength": 1, - "maxLength": 300 - }, - "serviceUrl": { - "type": "string", - "description": "Absolute URL of the backend service implementing this API.", - "minLength": 1, - "maxLength": 2000 - }, - "path": { - "type": "string", - "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.", - "minLength": 0, - "maxLength": 400 - }, - "protocols": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ], - "x-ms-enum": { - "name": "Protocol", - "modelAsString": true - } - }, - "description": "Describes on which protocols the operations in this API can be invoked." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ApiEntityBaseContract" - } - ], - "description": "API update contract properties." - }, - "ApiVersionSetCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiVersionSetContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged API Version Set list representation." - }, - "ApiVersionSetContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiVersionSetContractProperties", - "description": "API VersionSet contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "API Version Set Contract details." - }, - "ApiVersionSetContractDetails": { - "type": "object", - "description": "An API Version Set contains the common configuration for a set of API Versions relating ", - "properties": { - "id": { - "type": "string", - "description": "Identifier for existing API Version Set. Omit this value to create a new Version Set." - }, - "name": { - "type": "string", - "description": "The display Name of the API Version Set." - }, - "description": { - "type": "string", - "description": "Description of API Version Set." - }, - "versioningScheme": { - "type": "string", - "description": "An value that determines where the API Version identifier will be located in a HTTP request.", - "enum": [ - "Segment", - "Query", - "Header" - ], - "x-ms-enum": { - "name": "versioningScheme", - "modelAsString": true, - "values": [ - { - "value": "Segment", - "description": "The API Version is passed in a path segment." - }, - { - "value": "Query", - "description": "The API Version is passed in a query parameter." - }, - { - "value": "Header", - "description": "The API Version is passed in a HTTP header." - } - ] - } - }, - "versionQueryName": { - "type": "string", - "description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`." - }, - "versionHeaderName": { - "type": "string", - "description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`." - } - } - }, - "ApiVersionSetContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Name of API Version Set", - "minLength": 1, - "maxLength": 100 - }, - "versioningScheme": { - "type": "string", - "description": "An value that determines where the API Version identifier will be located in a HTTP request.", - "enum": [ - "Segment", - "Query", - "Header" - ], - "x-ms-enum": { - "name": "versioningScheme", - "modelAsString": true, - "values": [ - { - "value": "Segment", - "description": "The API Version is passed in a path segment." - }, - { - "value": "Query", - "description": "The API Version is passed in a query parameter." - }, - { - "value": "Header", - "description": "The API Version is passed in a HTTP header." - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/ApiVersionSetEntityBase" - } - ], - "required": [ - "displayName", - "versioningScheme" - ], - "description": "Properties of an API Version Set." - }, - "ApiVersionSetEntityBase": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of API Version Set." - }, - "versionQueryName": { - "type": "string", - "description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`.", - "minLength": 1, - "maxLength": 100 - }, - "versionHeaderName": { - "type": "string", - "description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.", - "minLength": 1, - "maxLength": 100 - } - }, - "description": "API Version set base parameters" - }, - "ApiVersionSetUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiVersionSetUpdateParametersProperties", - "description": "Parameters to update or create an API Version Set Contract." - } - }, - "description": "Parameters to update or create an API Version Set Contract." - }, - "ApiVersionSetUpdateParametersProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Name of API Version Set", - "minLength": 1, - "maxLength": 100 - }, - "versioningScheme": { - "type": "string", - "description": "An value that determines where the API Version identifier will be located in a HTTP request.", - "enum": [ - "Segment", - "Query", - "Header" - ], - "x-ms-enum": { - "name": "versioningScheme", - "modelAsString": true, - "values": [ - { - "value": "Segment", - "description": "The API Version is passed in a path segment." - }, - { - "value": "Query", - "description": "The API Version is passed in a query parameter." - }, - { - "value": "Header", - "description": "The API Version is passed in a HTTP header." - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/ApiVersionSetEntityBase" - } - ], - "description": "Properties used to create or update an API Version Set." - }, - "AuthenticationSettingsContract": { - "type": "object", - "properties": { - "oAuth2": { - "$ref": "#/definitions/OAuth2AuthenticationSettingsContract", - "description": "OAuth2 Authentication settings" - }, - "openid": { - "$ref": "#/definitions/OpenIdAuthenticationSettingsContract", - "description": "OpenID Connect Authentication Settings" - }, - "oAuth2AuthenticationSettings": { - "type": "array", - "items": { - "$ref": "#/definitions/OAuth2AuthenticationSettingsContract" - }, - "x-ms-identifiers": [ - "authorizationServerId" - ], - "description": "Collection of OAuth2 authentication settings included into this API." - }, - "openidAuthenticationSettings": { - "type": "array", - "items": { - "$ref": "#/definitions/OpenIdAuthenticationSettingsContract" - }, - "x-ms-identifiers": [ - "openidProviderId" - ], - "description": "Collection of Open ID Connect authentication settings included into this API." - } - }, - "description": "API Authentication Settings." - }, - "AuthorizationCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AuthorizationContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Authorization list representation." - }, - "AuthorizationContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AuthorizationContractProperties", - "description": "Properties of the Authorization Contract." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Authorization contract." - }, - "AuthorizationContractProperties": { - "type": "object", - "properties": { - "authorizationType": { - "type": "string", - "description": "Authorization type options", - "enum": [ - "OAuth2" - ], - "x-ms-client-name": "AuthorizationType", - "x-ms-enum": { - "name": "AuthorizationType", - "modelAsString": true, - "values": [ - { - "value": "OAuth2", - "description": "OAuth2 authorization type", - "name": "OAuth2" - } - ] - } - }, - "oauth2grantType": { - "type": "string", - "description": "OAuth2 grant type options", - "enum": [ - "AuthorizationCode", - "ClientCredentials" - ], - "x-ms-client-name": "OAuth2GrantType", - "x-ms-enum": { - "name": "OAuth2GrantType", - "modelAsString": true, - "values": [ - { - "value": "AuthorizationCode", - "description": "Authorization Code grant", - "name": "AuthorizationCode" - }, - { - "value": "ClientCredentials", - "description": "Client Credential grant", - "name": "ClientCredentials" - } - ] - } - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Authorization parameters" - }, - "error": { - "description": "", - "$ref": "#/definitions/AuthorizationError" - }, - "status": { - "type": "string", - "description": "Status of the Authorization" - } - }, - "description": "Authorization details." - }, - "AuthorizationError": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Error code" - }, - "message": { - "type": "string", - "description": "Error message" - } - }, - "description": "Authorization error details." - }, - "AuthorizationAccessPolicyCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AuthorizationAccessPolicyContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Authorization Access Policy list representation." - }, - "AuthorizationAccessPolicyContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AuthorizationAccessPolicyContractProperties", - "description": "Properties of the Authorization Contract." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Authorization access policy contract." - }, - "AuthorizationAccessPolicyContractProperties": { - "type": "object", - "properties": { - "appIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The allowed Azure Active Directory Application IDs" - }, - "tenantId": { - "type": "string", - "description": "The Tenant Id" - }, - "objectId": { - "type": "string", - "description": "The Object Id" - } - }, - "description": "Authorization Access Policy details." - }, - "AuthorizationLoginRequestContract": { - "type": "object", - "properties": { - "postLoginRedirectUrl": { - "type": "string", - "description": "The redirect URL after login has completed." - } - }, - "description": "Authorization login request contract." - }, - "AuthorizationLoginResponseContract": { - "type": "object", - "properties": { - "loginLink": { - "type": "string", - "description": "The login link" - } - }, - "description": "Authorization login response contract." - }, - "AuthorizationConfirmConsentCodeRequestContract": { - "type": "object", - "properties": { - "consentCode": { - "type": "string", - "description": "The consent code from the authorization server after authorizing and consenting." - } - }, - "description": "Authorization confirm consent code request contract." - }, - "AuthorizationProviderCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AuthorizationProviderContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Authorization Provider list representation." - }, - "AuthorizationProviderContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AuthorizationProviderContractProperties", - "description": "Properties of the Authorization Provider Contract." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Authorization Provider contract." - }, - "AuthorizationProviderContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Authorization Provider name. Must be 1 to 300 characters long.", - "minLength": 1, - "maxLength": 300 - }, - "identityProvider": { - "type": "string", - "description": "Identity provider name. Must be 1 to 300 characters long." - }, - "oauth2": { - "description": "OAuth2 settings", - "$ref": "#/definitions/AuthorizationProviderOAuth2Settings" - } - }, - "description": "Authorization Provider details." - }, - "AuthorizationProviderOAuth2Settings": { - "type": "object", - "properties": { - "redirectUrl": { - "type": "string", - "description": "Redirect URL to be set in the OAuth application." - }, - "grantTypes": { - "description": "OAuth2 settings", - "$ref": "#/definitions/AuthorizationProviderOAuth2GrantTypes" - } - }, - "description": "OAuth2 settings details" - }, - "AuthorizationProviderOAuth2GrantTypes": { - "type": "object", - "properties": { - "authorizationCode": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "OAuth2 authorization code grant parameters" - }, - "clientCredentials": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "OAuth2 client credential grant parameters" - } - }, - "description": "Authorization Provider oauth2 grant types settings" - }, - "AuthorizationServerCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AuthorizationServerContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged OAuth2 Authorization Servers list representation." - }, - "AuthorizationServerContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AuthorizationServerContractProperties", - "description": "Properties of the External OAuth authorization server Contract." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "External OAuth authorization server settings." - }, - "AuthorizationServerContractBaseProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the authorization server. Can contain HTML formatting tags." - }, - "authorizationMethods": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "HEAD", - "OPTIONS", - "TRACE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "x-ms-enum": { - "name": "AuthorizationMethod", - "modelAsString": false - } - }, - "description": "HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional." - }, - "clientAuthenticationMethod": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Basic", - "Body" - ], - "x-ms-enum": { - "name": "ClientAuthenticationMethod", - "modelAsString": true, - "values": [ - { - "value": "Basic", - "description": "Basic Client Authentication method." - }, - { - "value": "Body", - "description": "Body based Authentication method." - } - ] - } - }, - "description": "Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format." - }, - "tokenBodyParameters": { - "type": "array", - "items": { - "$ref": "#/definitions/TokenBodyParameterContract" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {\"name\" : \"name value\", \"value\": \"a value\"}." - }, - "tokenEndpoint": { - "type": "string", - "description": "OAuth token endpoint. Contains absolute URI to entity being referenced.", - "externalDocs": { - "url": "http://tools.ietf.org/html/rfc6749#section-3.1" - } - }, - "supportState": { - "type": "boolean", - "description": "If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.", - "externalDocs": { - "url": "http://tools.ietf.org/html/rfc6749#section-3.1" - } - }, - "defaultScope": { - "type": "string", - "description": "Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.", - "externalDocs": { - "url": "http://tools.ietf.org/html/rfc6749#section-3.3" - } - }, - "bearerTokenSendingMethods": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "authorizationHeader", - "query" - ], - "x-ms-enum": { - "name": "BearerTokenSendingMethod", - "modelAsString": true - } - }, - "description": "Specifies the mechanism by which access token is passed to the API. ", - "externalDocs": { - "url": "http://tools.ietf.org/html/rfc6749#section-4" - } - }, - "resourceOwnerUsername": { - "type": "string", - "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username." - }, - "resourceOwnerPassword": { - "type": "string", - "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password." - } - }, - "description": "External OAuth authorization server Update settings contract." - }, - "AuthorizationServerContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "User-friendly authorization server name.", - "minLength": 1, - "maxLength": 50 - }, - "useInTestConsole": { - "type": "boolean", - "description": "If true, the authorization server may be used in the developer portal test console. True by default if no value is provided." - }, - "useInApiDocumentation": { - "type": "boolean", - "description": "If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided." - }, - "clientRegistrationEndpoint": { - "type": "string", - "description": "Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced." - }, - "authorizationEndpoint": { - "type": "string", - "description": "OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2." - }, - "grantTypes": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "authorizationCode", - "implicit", - "resourceOwnerPassword", - "clientCredentials" - ], - "x-ms-enum": { - "name": "GrantType", - "modelAsString": true, - "values": [ - { - "value": "authorizationCode", - "description": "Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1." - }, - { - "value": "implicit", - "description": "Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2." - }, - { - "value": "resourceOwnerPassword", - "description": "Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3." - }, - { - "value": "clientCredentials", - "description": "Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4." - } - ] - } - }, - "description": "Form of an authorization grant, which the client uses to request the access token.", - "externalDocs": { - "url": "http://tools.ietf.org/html/rfc6749#section-4" - } - }, - "clientId": { - "type": "string", - "description": "Client or app id registered with this authorization server." - }, - "clientSecret": { - "x-ms-secret": true, - "type": "string", - "description": "Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AuthorizationServerContractBaseProperties" - } - ], - "required": [ - "displayName", - "clientRegistrationEndpoint", - "authorizationEndpoint", - "clientId", - "grantTypes" - ], - "description": "External OAuth authorization server settings Properties." - }, - "AuthorizationServerUpdateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AuthorizationServerUpdateContractProperties", - "description": "Properties of the External OAuth authorization server update Contract." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "External OAuth authorization server settings." - }, - "AuthorizationServerUpdateContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "User-friendly authorization server name.", - "minLength": 1, - "maxLength": 50 - }, - "useInTestConsole": { - "type": "boolean", - "description": "If true, the authorization server may be used in the developer portal test console. True by default if no value is provided." - }, - "useInApiDocumentation": { - "type": "boolean", - "description": "If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided." - }, - "clientRegistrationEndpoint": { - "type": "string", - "description": "Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced." - }, - "authorizationEndpoint": { - "type": "string", - "description": "OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2." - }, - "grantTypes": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "authorizationCode", - "implicit", - "resourceOwnerPassword", - "clientCredentials" - ], - "x-ms-enum": { - "name": "GrantType", - "modelAsString": true, - "values": [ - { - "value": "authorizationCode", - "description": "Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1." - }, - { - "value": "implicit", - "description": "Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2." - }, - { - "value": "resourceOwnerPassword", - "description": "Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3." - }, - { - "value": "clientCredentials", - "description": "Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4." - } - ] - } - }, - "description": "Form of an authorization grant, which the client uses to request the access token.", - "externalDocs": { - "url": "http://tools.ietf.org/html/rfc6749#section-4" - } - }, - "clientId": { - "type": "string", - "description": "Client or app id registered with this authorization server." - }, - "clientSecret": { - "x-ms-secret": true, - "type": "string", - "description": "Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AuthorizationServerContractBaseProperties" - } - ], - "description": "External OAuth authorization server Update settings contract." - }, - "AuthorizationServerSecretsContract": { - "type": "object", - "properties": { - "clientSecret": { - "type": "string", - "x-ms-secret": true, - "description": "oAuth Authorization Server Secrets." - }, - "resourceOwnerUsername": { - "type": "string", - "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username." - }, - "resourceOwnerPassword": { - "type": "string", - "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password." - } - }, - "description": "OAuth Server Secrets Contract." - }, - "BackendAuthorizationHeaderCredentials": { - "type": "object", - "properties": { - "scheme": { - "type": "string", - "description": "Authentication Scheme name.", - "minLength": 1, - "maxLength": 100 - }, - "parameter": { - "type": "string", - "description": "Authentication Parameter value.", - "minLength": 1, - "maxLength": 300 - } - }, - "required": [ - "scheme", - "parameter" - ], - "description": "Authorization header information." - }, - "BackendBaseParameters": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Backend Title.", - "minLength": 1, - "maxLength": 300 - }, - "description": { - "type": "string", - "description": "Backend Description.", - "minLength": 1, - "maxLength": 2000 - }, - "resourceId": { - "type": "string", - "description": "Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.", - "minLength": 1, - "maxLength": 2000 - }, - "properties": { - "$ref": "#/definitions/BackendProperties", - "description": "Backend Properties contract" - }, - "credentials": { - "$ref": "#/definitions/BackendCredentialsContract", - "description": "Backend Credentials Contract Properties" - }, - "proxy": { - "$ref": "#/definitions/BackendProxyContract", - "description": "Backend gateway Contract Properties" - }, - "tls": { - "$ref": "#/definitions/BackendTlsProperties", - "description": "Backend TLS Properties" - }, - "circuitBreaker": { - "$ref": "#/definitions/BackendCircuitBreaker", - "description": "Backend Circuit Breaker Configuration" - }, - "pool": { - "allOf": [ - { - "$ref": "#/definitions/BackendPool" - }, - { - "description": "Backend Pool Properties" - } - ] - }, - "type": { - "type": "string", - "enum": [ - "Single", - "Pool" - ], - "x-ms-enum": { - "name": "BackendType", - "modelAsString": true, - "values": [ - { - "value": "Single", - "description": "supports single backend" - }, - { - "value": "Pool", - "description": "supports pool backend" - } - ] - }, - "description": "Type of the backend. A backend can be either Single or Pool." - } - }, - "description": "Backend entity base Parameter set." - }, - "BackendCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/BackendContract" - }, - "description": "Backend values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Backend list representation." - }, - "BackendContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/BackendContractProperties", - "description": "Backend entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Backend details." - }, - "BackendContractProperties": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "Runtime Url of the Backend. Required when backend type is 'Single'.", - "minLength": 1, - "maxLength": 2000 - }, - "protocol": { - "type": "string", - "enum": [ - "http", - "soap" - ], - "x-ms-enum": { - "name": "BackendProtocol", - "modelAsString": true, - "values": [ - { - "value": "http", - "description": "The Backend is a RESTful service." - }, - { - "value": "soap", - "description": "The Backend is a SOAP service." - } - ] - }, - "description": "Backend communication protocol. Required when backend type is 'Single'." - } - }, - "allOf": [ - { - "$ref": "#/definitions/BackendBaseParameters" - } - ], - "description": "Parameters supplied to the Create Backend operation." - }, - "BackendCredentialsContract": { - "type": "object", - "properties": { - "certificateIds": { - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 32, - "description": "List of Client Certificate Ids." - }, - "certificate": { - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 32, - "description": "List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided." - }, - "query": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": "Query Parameter description." - }, - "header": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": "Header Parameter description." - }, - "authorization": { - "description": "Authorization header authentication", - "$ref": "#/definitions/BackendAuthorizationHeaderCredentials" - } - }, - "description": "Details of the Credentials used to connect to Backend." - }, - "BackendProperties": { - "type": "object", - "properties": { - "serviceFabricCluster": { - "$ref": "#/definitions/BackendServiceFabricClusterProperties", - "description": "Backend Service Fabric Cluster Properties" - } - }, - "description": "Properties specific to the Backend Type." - }, - "BackendProxyContract": { - "type": "object", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/system.net.webproxy(v=vs.110).aspx", - "description": "Backend entity uses these details to connect to a WebProxy." - }, - "properties": { - "url": { - "type": "string", - "description": "WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.", - "minLength": 1, - "maxLength": 2000 - }, - "username": { - "type": "string", - "description": "Username to connect to the WebProxy server" - }, - "password": { - "type": "string", - "description": "Password to connect to the WebProxy Server" - } - }, - "required": [ - "url" - ], - "description": "Details of the Backend WebProxy Server to use in the Request to Backend." - }, - "BackendReconnectContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/BackendReconnectProperties", - "description": "Reconnect request properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Reconnect request parameters." - }, - "BackendReconnectProperties": { - "type": "object", - "properties": { - "after": { - "type": "string", - "format": "duration", - "description": "Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconnect is PT2M." - } - }, - "description": "Properties to control reconnect requests." - }, - "BackendServiceFabricClusterProperties": { - "type": "object", - "properties": { - "clientCertificateId": { - "description": "The client certificate id for the management endpoint.", - "type": "string" - }, - "clientCertificatethumbprint": { - "description": "The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided", - "type": "string" - }, - "maxPartitionResolutionRetries": { - "description": "Maximum number of retries while attempting resolve the partition.", - "format": "int32", - "type": "integer" - }, - "managementEndpoints": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The cluster management endpoint." - }, - "serverCertificateThumbprints": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Thumbprints of certificates cluster management service uses for tls communication" - }, - "serverX509Names": { - "type": "array", - "items": { - "$ref": "#/definitions/X509CertificateName" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "Server X509 Certificate Names Collection" - } - }, - "required": [ - "managementEndpoints" - ], - "description": "Properties of the Service Fabric Type Backend." - }, - "BackendTlsProperties": { - "type": "object", - "properties": { - "validateCertificateChain": { - "description": "Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.", - "type": "boolean", - "default": true - }, - "validateCertificateName": { - "description": "Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.", - "type": "boolean", - "default": true - } - }, - "description": "Properties controlling TLS Certificate Validation." - }, - "BackendUpdateParameterProperties": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "Runtime Url of the Backend. Required when backend type is 'Single'.", - "minLength": 1, - "maxLength": 2000 - }, - "protocol": { - "type": "string", - "enum": [ - "http", - "soap" - ], - "x-ms-enum": { - "name": "BackendProtocol", - "modelAsString": true, - "values": [ - { - "value": "http", - "description": "The Backend is a RESTful service." - }, - { - "value": "soap", - "description": "The Backend is a SOAP service." - } - ] - }, - "description": "Backend communication protocol. Required when backend type is 'Single'." - } - }, - "allOf": [ - { - "$ref": "#/definitions/BackendBaseParameters" - } - ], - "description": "Parameters supplied to the Update Backend operation." - }, - "BackendUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/BackendUpdateParameterProperties", - "description": "Backend entity update contract properties." - } - }, - "description": "Backend update parameters." - }, - "BackendCircuitBreaker": { - "type": "object", - "description": "The configuration of the backend circuit breaker", - "properties": { - "rules": { - "type": "array", - "items": { - "$ref": "#/definitions/CircuitBreakerRule" - }, - "maxItems": 15, - "description": "The rules for tripping the backend.", - "x-ms-identifiers": [] - } - } - }, - "CircuitBreakerRule": { - "type": "object", - "description": "Rule configuration to trip the backend.", - "properties": { - "name": { - "type": "string", - "description": "The rule name." - }, - "failureCondition": { - "$ref": "#/definitions/CircuitBreakerFailureCondition", - "description": "The conditions for tripping the circuit breaker." - }, - "tripDuration": { - "type": "string", - "format": "duration", - "description": "The duration for which the circuit will be tripped." - }, - "acceptRetryAfter": { - "type": "boolean", - "description": "flag to accept Retry-After header from the backend." - }, - "failureResponse": { - "$ref": "#/definitions/BackendFailureResponse", - "description": "The response of the backend when the circuit breaker gets open." - } - } - }, - "BackendFailureResponse": { - "type": "object", - "description": "The response to be returned when a backend fails to respond", - "properties": { - "statusCode": { - "type": "integer", - "format": "int32", - "description": "The status code of the response.", - "minimum": 100, - "maximum": 599 - } - } - }, - "CircuitBreakerFailureCondition": { - "type": "object", - "description": "The trip conditions of the circuit breaker", - "properties": { - "count": { - "type": "integer", - "format": "int64", - "description": "The threshold for opening the circuit." - }, - "percentage": { - "type": "integer", - "format": "int64", - "description": "The threshold for opening the circuit." - }, - "interval": { - "type": "string", - "format": "duration", - "description": "The interval during which the failures are counted." - }, - "statusCodeRanges": { - "type": "array", - "items": { - "$ref": "#/definitions/FailureStatusCodeRange" - }, - "maxItems": 10, - "description": "The status code ranges which are considered as failure.", - "x-ms-identifiers": [] - }, - "errorReasons": { - "type": "array", - "items": { - "type": "string", - "maxLength": 200 - }, - "maxItems": 10, - "description": "The error reasons which are considered as failure.", - "x-ms-identifiers": [] - } - } - }, - "ClientApplicationCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ClientApplicationContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged ClientApplication list representation." - }, - "ClientApplicationContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ClientApplicationContractProperties", - "description": "Client application entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Client application details." - }, - "ClientApplicationContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Client application name.", - "minLength": 0, - "maxLength": 300 - }, - "description": { - "type": "string", - "description": "Client application description.", - "minLength": 0, - "maxLength": 1000 - }, - "ownerId": { - "type": "string", - "description": "A resource identifier for the user who owns the application." - }, - "entraApplicationId": { - "type": "string", - "readOnly": true, - "description": "Microsoft EntraID Application ID (Client ID). This is the value that is used to identify the application when it is requesting access tokens from Microsoft EntraID. This property is read-only and will be set by the system when the application is created." - }, - "entraTenantId": { - "type": "string", - "readOnly": true, - "description": "Tenant ID is a unique identifier (a GUID) for an organization directory in Microsoft’s cloud. It’s used to identify tenants across Microsoft services." - }, - "state": { - "type": "string", - "readOnly": true, - "description": "Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks.", - "enum": [ - "pending", - "active", - "rejected", - "approved" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "ClientApplicationState", - "values": [ - { - "value": "pending", - "description": "If there are no associated ClientApplicationLinks or all ClientApplicationLinks are in a state that doesn't meet the criteria for the states: active, rejected, approved (e.g., a mix of active and rejected without any approved)." - }, - { - "value": "active", - "description": "If there are no approved ClientApplicationLink, but at least one ClientApplicationLink is active, the Application is considered active" - }, - { - "value": "rejected", - "description": "If all ClientApplicationLinks are rejected, the Application is considered rejected" - }, - { - "value": "approved", - "description": "If at least one ClientApplicationLink is approved, the Application is considered approved" - } - ] - } - } - }, - "required": [ - "displayName", - "ownerId" - ], - "description": "Client Application Entity Properties" - }, - "ClientApplicationSecretsContract": { - "type": "object", - "description": "Specifies client application secrets needed to authorize applications API calls", - "properties": { - "entra": { - "type": "object", - "description": "Microsoft EntraID client application secrets", - "properties": { - "clientSecret": { - "type": "string", - "x-ms-secret": true, - "description": "EntraID client application secret" - }, - "expiresAt": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "EntraID client application secret expiration date." - } - } - } - } - }, - "ClientApplicationProductLinkCollection": { - "type": "object", - "description": "Paged ClientApplicationProductLinkContract list representation.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ClientApplicationProductLinkContract" - }, - "description": "Page values." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - } - }, - "ClientApplicationProductLinkContract": { - "type": "object", - "description": "Specifies Client Application - Product link assignment", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ClientApplicationProductLinkContractProperties", - "description": "Client application - product link entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ] - }, - "ClientApplicationProductLinkContractProperties": { - "type": "object", - "properties": { - "productId": { - "type": "string", - "description": "The unique resource identifier of the Product." - } - }, - "required": [ - "productId" - ] - }, - "FailureStatusCodeRange": { - "type": "object", - "description": "The failure http status code range", - "properties": { - "min": { - "type": "integer", - "format": "int32", - "description": "The minimum http status code.", - "minimum": 200, - "maximum": 599 - }, - "max": { - "type": "integer", - "format": "int32", - "description": "The maximum http status code.", - "minimum": 200, - "maximum": 599 - } - } - }, - "BackendPool": { - "type": "object", - "description": "Backend pool information", - "properties": { - "services": { - "type": "array", - "description": "The list of backend entities belonging to a pool.", - "items": { - "$ref": "#/definitions/BackendPoolItem" - }, - "minItems": 1, - "x-ms-identifiers": [], - "example": { - "services": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends" - } - }, - "failureResponse": { - "$ref": "#/definitions/BackendFailureResponse", - "description": "The response to be returned when all the backends in the pool are inactive." - }, - "sessionAffinity": { - "$ref": "#/definitions/BackendSessionAffinity", - "description": "The session stickiness properties of the backend pool." - } - } - }, - "BackendPoolItem": { - "type": "object", - "description": "Backend pool service information", - "properties": { - "id": { - "type": "string", - "format": "arm-id", - "description": "The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.", - "example": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend" - } - }, - "weight": { - "type": "integer", - "format": "int32", - "description": "The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.", - "minimum": 0, - "maximum": 100, - "example": { - "weight": 1 - } - }, - "priority": { - "type": "integer", - "format": "int32", - "description": "The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.", - "minimum": 0, - "maximum": 100, - "example": { - "priority": 1 - } - } - }, - "required": [ - "id" - ] - }, - "BackendSessionAffinity": { - "type": "object", - "description": "The session stickiness properties of the backend pool.", - "properties": { - "sessionId": { - "$ref": "#/definitions/BackendSessionId", - "description": "The id that identifies the requests belonging to the same session." - } - } - }, - "BackendSessionId": { - "type": "object", - "description": "The properties of the id that identifies the requests belonging to the same session.", - "properties": { - "source": { - "$ref": "#/definitions/BackendSessionIdSource", - "description": "Source from where the session id is extracted." - }, - "name": { - "type": "string", - "description": "Name of the variable that refers to the session id." - } - } - }, - "BackendSessionIdSource": { - "type": "string", - "description": "Source from where the session id is extracted.", - "enum": [ - "cookie" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "backend-sessionId-source", - "values": [ - { - "value": "cookie", - "description": "The session id is set by APIM gateway in a cookie and is extracted from the cookies in client requests." - } - ] - } - }, - "BearerTokenSendingMethodsContract": { - "type": "string", - "description": "Form of an authorization grant, which the client uses to request the access token.", - "enum": [ - "authorizationHeader", - "query" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "bearerTokenSendingMethods", - "values": [ - { - "value": "authorizationHeader", - "description": "Access token will be transmitted in the Authorization header using Bearer schema" - }, - { - "value": "query", - "description": "Access token will be transmitted as query parameters." - } - ] - } - }, - "BodyDiagnosticSettings": { - "type": "object", - "properties": { - "bytes": { - "type": "integer", - "format": "int32", - "maximum": 8192, - "description": "Number of request body bytes to log." - } - }, - "description": "Body logging settings." - }, - "CacheCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/CacheContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Caches list representation." - }, - "CacheContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/CacheContractProperties", - "description": "Cache properties details." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Cache details." - }, - "CacheContractProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Cache description", - "maxLength": 2000 - }, - "connectionString": { - "type": "string", - "description": "Runtime connection string to cache", - "maxLength": 300 - }, - "useFromLocation": { - "type": "string", - "description": "Location identifier to use cache from (should be either 'default' or valid Azure region identifier)", - "maxLength": 256 - }, - "resourceId": { - "type": "string", - "description": "Original uri of entity in external system cache points to", - "maxLength": 2000 - } - }, - "required": [ - "connectionString", - "useFromLocation" - ], - "description": "Properties of the Cache contract." - }, - "CacheUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/CacheUpdateProperties", - "description": "Cache update properties details." - } - }, - "description": "Cache update details." - }, - "CacheUpdateProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Cache description", - "maxLength": 2000 - }, - "connectionString": { - "type": "string", - "description": "Runtime connection string to cache", - "maxLength": 300 - }, - "useFromLocation": { - "type": "string", - "description": "Location identifier to use cache from (should be either 'default' or valid Azure region identifier)", - "maxLength": 256 - }, - "resourceId": { - "type": "string", - "description": "Original uri of entity in external system cache points to", - "maxLength": 2000 - } - }, - "description": "Parameters supplied to the Update Cache operation." - }, - "CertificateCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/CertificateContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Certificates list representation." - }, - "CertificateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/CertificateContractProperties", - "description": "Certificate properties details." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Certificate details." - }, - "CertificateContractProperties": { - "type": "object", - "properties": { - "subject": { - "type": "string", - "description": "Subject attribute of the certificate." - }, - "thumbprint": { - "type": "string", - "description": "Thumbprint of the certificate." - }, - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "keyVault": { - "$ref": "#/definitions/KeyVaultContractProperties", - "description": "KeyVault location details of the certificate." - } - }, - "required": [ - "subject", - "thumbprint", - "expirationDate" - ], - "description": "Properties of the Certificate contract." - }, - "CertificateCreateOrUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/CertificateCreateOrUpdateProperties", - "description": "Certificate create or update properties details." - } - }, - "description": "Certificate create or update details." - }, - "CertificateCreateOrUpdateProperties": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Base 64 encoded certificate using the application/x-pkcs12 representation." - }, - "password": { - "type": "string", - "description": "Password for the Certificate" - }, - "keyVault": { - "$ref": "#/definitions/KeyVaultContractCreateProperties", - "description": "KeyVault location details of the certificate." - } - }, - "description": "Parameters supplied to the CreateOrUpdate certificate operation." - }, - "DataMasking": { - "type": "object", - "properties": { - "queryParams": { - "type": "array", - "items": { - "$ref": "#/definitions/DataMaskingEntity" - }, - "x-ms-identifiers": [], - "description": "Masking settings for Url query parameters" - }, - "headers": { - "type": "array", - "items": { - "$ref": "#/definitions/DataMaskingEntity" - }, - "x-ms-identifiers": [], - "description": "Masking settings for headers" - } - } - }, - "DataMaskingEntity": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "The name of an entity to mask (e.g. a name of a header or a query parameter)." - }, - "mode": { - "type": "string", - "enum": [ - "Mask", - "Hide" - ], - "x-ms-enum": { - "name": "DataMaskingMode", - "modelAsString": true, - "values": [ - { - "value": "Mask", - "description": "Mask the value of an entity." - }, - { - "value": "Hide", - "description": "Hide the presence of an entity." - } - ] - }, - "description": "Data masking mode." - } - } - }, - "DeployConfigurationParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DeployConfigurationParameterProperties", - "description": "Deploy Configuration Parameter contract properties." - } - }, - "description": "Deploy Tenant Configuration Contract." - }, - "DeployConfigurationParameterProperties": { - "type": "object", - "properties": { - "branch": { - "type": "string", - "description": "The name of the Git branch from which the configuration is to be deployed to the configuration database." - }, - "force": { - "type": "boolean", - "description": "The value enforcing deleting subscriptions to products that are deleted in this update." - } - }, - "required": [ - "branch" - ], - "description": "Parameters supplied to the Deploy Configuration operation." - }, - "DiagnosticCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DiagnosticContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Diagnostic list representation." - }, - "DiagnosticContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DiagnosticContractProperties", - "description": "Diagnostic entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Diagnostic details." - }, - "DiagnosticContractProperties": { - "type": "object", - "properties": { - "alwaysLog": { - "type": "string", - "enum": [ - "allErrors" - ], - "x-ms-enum": { - "name": "AlwaysLog", - "modelAsString": true, - "values": [ - { - "value": "allErrors", - "description": "Always log all erroneous request regardless of sampling settings." - } - ] - }, - "description": "Specifies for what type of messages sampling settings should not apply." - }, - "loggerId": { - "type": "string", - "description": "Resource Id of a target logger." - }, - "sampling": { - "$ref": "#/definitions/SamplingSettings", - "description": "Sampling settings for Diagnostic." - }, - "frontend": { - "$ref": "#/definitions/PipelineDiagnosticSettings", - "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." - }, - "backend": { - "$ref": "#/definitions/PipelineDiagnosticSettings", - "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Backend" - }, - "largeLanguageModel": { - "$ref": "#/definitions/LLMDiagnosticSettings", - "description": "Large Language Models diagnostic settings" - }, - "logClientIp": { - "type": "boolean", - "description": "Log the ClientIP. Default is false." - }, - "httpCorrelationProtocol": { - "type": "string", - "enum": [ - "None", - "Legacy", - "W3C" - ], - "x-ms-enum": { - "name": "HttpCorrelationProtocol", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "Do not read and inject correlation headers." - }, - { - "value": "Legacy", - "description": "Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md." - }, - { - "value": "W3C", - "description": "Inject Trace Context headers. See https://w3c.github.io/trace-context." - } - ] - }, - "description": "Sets correlation protocol to use for Application Insights diagnostics." - }, - "verbosity": { - "type": "string", - "enum": [ - "verbose", - "information", - "error" - ], - "x-ms-enum": { - "name": "Verbosity", - "modelAsString": true, - "values": [ - { - "value": "verbose", - "description": "All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance." - }, - { - "value": "information", - "description": "Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance." - }, - { - "value": "error", - "description": "Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance." - } - ] - }, - "description": "The verbosity level applied to traces emitted by trace policies." - }, - "operationNameFormat": { - "type": "string", - "enum": [ - "Name", - "Url" - ], - "x-ms-enum": { - "name": "OperationNameFormat", - "modelAsString": true, - "values": [ - { - "value": "Name", - "description": "API_NAME;rev=API_REVISION - OPERATION_NAME" - }, - { - "value": "Url", - "description": "HTTP_VERB URL" - } - ] - }, - "description": "The format of the Operation Name for Application Insights telemetries. Default is Name." - }, - "metrics": { - "type": "boolean", - "description": "Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings." - } - }, - "required": [ - "loggerId" - ], - "description": "Diagnostic Entity Properties" - }, - "DiagnosticUpdateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DiagnosticContractUpdateProperties", - "description": "Diagnostic entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Diagnostic details." - }, - "DiagnosticContractUpdateProperties": { - "type": "object", - "properties": { - "alwaysLog": { - "type": "string", - "enum": [ - "allErrors" - ], - "x-ms-enum": { - "name": "AlwaysLog", - "modelAsString": true, - "values": [ - { - "value": "allErrors", - "description": "Always log all erroneous request regardless of sampling settings." - } - ] - }, - "description": "Specifies for what type of messages sampling settings should not apply." - }, - "loggerId": { - "type": "string", - "description": "Resource Id of a target logger." - }, - "sampling": { - "$ref": "#/definitions/SamplingSettings", - "description": "Sampling settings for Diagnostic." - }, - "frontend": { - "$ref": "#/definitions/PipelineDiagnosticSettings", - "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." - }, - "backend": { - "$ref": "#/definitions/PipelineDiagnosticSettings", - "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Backend" - }, - "logClientIp": { - "type": "boolean", - "description": "Log the ClientIP. Default is false." - }, - "httpCorrelationProtocol": { - "type": "string", - "enum": [ - "None", - "Legacy", - "W3C" - ], - "x-ms-enum": { - "name": "HttpCorrelationProtocol", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "Do not read and inject correlation headers." - }, - { - "value": "Legacy", - "description": "Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md." - }, - { - "value": "W3C", - "description": "Inject Trace Context headers. See https://w3c.github.io/trace-context." - } - ] - }, - "description": "Sets correlation protocol to use for Application Insights diagnostics." - }, - "verbosity": { - "type": "string", - "enum": [ - "verbose", - "information", - "error" - ], - "x-ms-enum": { - "name": "Verbosity", - "modelAsString": true, - "values": [ - { - "value": "verbose", - "description": "All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance." - }, - { - "value": "information", - "description": "Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance." - }, - { - "value": "error", - "description": "Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance." - } - ] - }, - "description": "The verbosity level applied to traces emitted by trace policies." - }, - "operationNameFormat": { - "type": "string", - "enum": [ - "Name", - "Url" - ], - "x-ms-enum": { - "name": "OperationNameFormat", - "modelAsString": true, - "values": [ - { - "value": "Name", - "description": "API_NAME;rev=API_REVISION - OPERATION_NAME" - }, - { - "value": "Url", - "description": "HTTP_VERB URL" - } - ] - }, - "description": "The format of the Operation Name for Application Insights telemetries. Default is Name." - }, - "metrics": { - "type": "boolean", - "description": "Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings." - } - }, - "description": "Diagnostic Entity Properties" - }, - "EmailTemplateCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/EmailTemplateContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged email template list representation." - }, - "EmailTemplateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/EmailTemplateContractProperties", - "description": "Email Template entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Email Template details." - }, - "EmailTemplateContractProperties": { - "type": "object", - "properties": { - "subject": { - "type": "string", - "description": "Subject of the Template.", - "minLength": 1, - "maxLength": 1000 - }, - "body": { - "type": "string", - "description": "Email Template Body. This should be a valid XDocument", - "minLength": 1 - }, - "title": { - "type": "string", - "description": "Title of the Template." - }, - "description": { - "type": "string", - "description": "Description of the Email Template." - }, - "isDefault": { - "type": "boolean", - "description": "Whether the template is the default template provided by API Management or has been edited.", - "readOnly": true - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/definitions/EmailTemplateParametersContractProperties" - }, - "x-ms-identifiers": [ - "title" - ], - "description": "Email Template Parameter values." - } - }, - "required": [ - "body", - "subject" - ], - "description": "Email Template Contract properties." - }, - "EmailTemplateParametersContractProperties": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Template parameter name.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[A-Za-z0-9-._]+$" - }, - "title": { - "type": "string", - "description": "Template parameter title.", - "minLength": 1, - "maxLength": 4096 - }, - "description": { - "type": "string", - "description": "Template parameter description.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[A-Za-z0-9-._]+$" - } - }, - "description": "Email Template Parameter contract." - }, - "EmailTemplateUpdateParameterProperties": { - "type": "object", - "properties": { - "subject": { - "type": "string", - "description": "Subject of the Template.", - "minLength": 1, - "maxLength": 1000 - }, - "title": { - "type": "string", - "description": "Title of the Template." - }, - "description": { - "type": "string", - "description": "Description of the Email Template." - }, - "body": { - "type": "string", - "description": "Email Template Body. This should be a valid XDocument", - "minLength": 1 - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/definitions/EmailTemplateParametersContractProperties" - }, - "x-ms-identifiers": [ - "title" - ], - "description": "Email Template Parameter values." - } - }, - "description": "Email Template Update Contract properties." - }, - "EmailTemplateUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/EmailTemplateUpdateParameterProperties", - "description": "Email Template Update contract properties." - } - }, - "description": "Email Template update Parameters." - }, - "GenerateSsoUrlResult": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "Redirect Url containing the SSO URL value." - } - }, - "description": "Generate SSO Url operations response details." - }, - "GroupCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/GroupContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Group list representation." - }, - "GroupContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/GroupContractProperties", - "description": "Group entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Contract details." - }, - "GroupContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Group name.", - "maxLength": 300, - "minLength": 1 - }, - "description": { - "type": "string", - "description": "Group description. Can contain HTML formatting tags.", - "maxLength": 1000 - }, - "builtIn": { - "readOnly": true, - "type": "boolean", - "description": "true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false." - }, - "type": { - "type": "string", - "description": "Group type.", - "enum": [ - "custom", - "system", - "external" - ], - "x-ms-enum": { - "name": "GroupType", - "modelAsString": false - } - }, - "externalId": { - "type": "string", - "description": "For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null." - } - }, - "required": [ - "displayName" - ], - "description": "Group contract Properties." - }, - "GroupCreateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/GroupCreateParametersProperties", - "description": "Properties supplied to Create Group operation." - } - }, - "description": "Parameters supplied to the Create Group operation." - }, - "GroupCreateParametersProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Group name.", - "maxLength": 300, - "minLength": 1 - }, - "description": { - "type": "string", - "description": "Group description." - }, - "type": { - "type": "string", - "description": "Group type.", - "enum": [ - "custom", - "system", - "external" - ], - "x-ms-enum": { - "name": "GroupType", - "modelAsString": false - } - }, - "externalId": { - "type": "string", - "description": "Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null." - } - }, - "required": [ - "displayName" - ], - "description": "Parameters supplied to the Create Group operation." - }, - "GroupUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/GroupUpdateParametersProperties", - "description": "Group entity update contract properties." - } - }, - "description": "Parameters supplied to the Update Group operation." - }, - "GroupUpdateParametersProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Group name.", - "maxLength": 300, - "minLength": 1 - }, - "description": { - "type": "string", - "description": "Group description." - }, - "type": { - "type": "string", - "description": "Group type.", - "enum": [ - "custom", - "system", - "external" - ], - "x-ms-enum": { - "name": "GroupType", - "modelAsString": false - } - }, - "externalId": { - "type": "string", - "description": "Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null." - } - }, - "description": "Parameters supplied to the Update Group operation." - }, - "HttpMessageDiagnostic": { - "type": "object", - "properties": { - "headers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of HTTP Headers to log." - }, - "body": { - "$ref": "#/definitions/BodyDiagnosticSettings", - "description": "Body logging settings." - }, - "dataMasking": { - "$ref": "#/definitions/DataMasking", - "description": "Data masking settings." - } - }, - "description": "Http message diagnostic settings." - }, - "IdentityProviderBaseParameters": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "facebook", - "google", - "microsoft", - "twitter", - "aad", - "aadB2C" - ], - "x-ms-enum": { - "name": "IdentityProviderType", - "modelAsString": true, - "values": [ - { - "value": "facebook", - "description": "Facebook as Identity provider." - }, - { - "value": "google", - "description": "Google as Identity provider." - }, - { - "value": "microsoft", - "description": "Microsoft Live as Identity provider." - }, - { - "value": "twitter", - "description": "Twitter as Identity provider." - }, - { - "value": "aad", - "description": "Azure Active Directory as Identity provider." - }, - { - "value": "aadB2C", - "description": "Azure Active Directory B2C as Identity provider." - } - ] - }, - "description": "Identity Provider Type identifier." - }, - "signinTenant": { - "type": "string", - "description": "The TenantId to use instead of Common when logging into Active Directory" - }, - "allowedTenants": { - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 32, - "description": "List of Allowed Tenants when configuring Azure Active Directory login." - }, - "authority": { - "type": "string", - "description": "OpenID Connect discovery endpoint hostname for AAD or AAD B2C." - }, - "signupPolicyName": { - "type": "string", - "description": "Signup Policy Name. Only applies to AAD B2C Identity Provider.", - "minLength": 1 - }, - "signinPolicyName": { - "type": "string", - "description": "Signin Policy Name. Only applies to AAD B2C Identity Provider.", - "minLength": 1 - }, - "profileEditingPolicyName": { - "type": "string", - "description": "Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.", - "minLength": 1 - }, - "passwordResetPolicyName": { - "type": "string", - "description": "Password Reset Policy Name. Only applies to AAD B2C Identity Provider.", - "minLength": 1 - }, - "clientLibrary": { - "type": "string", - "description": "The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.", - "minLength": 0, - "maxLength": 16 - } - }, - "description": "Identity Provider Base Parameter Properties." - }, - "IdentityProviderCreateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IdentityProviderCreateContractProperties", - "description": "Identity Provider contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Identity Provider details." - }, - "IdentityProviderCreateContractProperties": { - "type": "object", - "properties": { - "clientId": { - "type": "string", - "description": "Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.", - "minLength": 1 - }, - "clientSecret": { - "x-ms-secret": true, - "type": "string", - "description": "Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", - "minLength": 1 - }, - "certificateId": { - "type": "string", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ApiManagement/service/certificates" - } - ] - }, - "example": { - "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCert" - }, - "description": "Certificate full resource ID used in external Identity Provider" - } - }, - "allOf": [ - { - "$ref": "#/definitions/IdentityProviderBaseParameters" - } - ], - "required": [ - "clientId", - "clientSecret" - ], - "description": "The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users." - }, - "IdentityProviderContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IdentityProviderContractProperties", - "description": "Identity Provider contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Identity Provider details." - }, - "IdentityProviderContractProperties": { - "type": "object", - "properties": { - "clientId": { - "type": "string", - "description": "Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.", - "minLength": 1 - }, - "clientSecret": { - "x-ms-secret": true, - "type": "string", - "description": "Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", - "minLength": 1 - }, - "certificateId": { - "type": "string", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ApiManagement/service/certificates" - } - ] - }, - "description": "Certificate full resource ID used in external Identity Provider" - } - }, - "allOf": [ - { - "$ref": "#/definitions/IdentityProviderBaseParameters" - } - ], - "required": [ - "clientId" - ], - "description": "The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users." - }, - "IdentityProviderList": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IdentityProviderContract" - }, - "description": "Identity Provider configuration values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "List of all the Identity Providers configured on the service instance." - }, - "IdentityProviderUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IdentityProviderUpdateProperties", - "description": "Identity Provider update properties." - } - }, - "description": "Parameters supplied to update Identity Provider" - }, - "IdentityProviderUpdateProperties": { - "type": "object", - "properties": { - "clientId": { - "type": "string", - "description": "Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.", - "minLength": 1 - }, - "clientSecret": { - "x-ms-secret": true, - "type": "string", - "description": "Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.", - "minLength": 1 - }, - "certificateId": { - "type": "string", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ApiManagement/service/certificates" - } - ] - }, - "example": { - "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCert" - }, - "description": "Certificate full resource ID used in external Identity Provider" - } - }, - "allOf": [ - { - "$ref": "#/definitions/IdentityProviderBaseParameters" - } - ], - "description": "Parameters supplied to the Update Identity Provider operation." - }, - "IssueAttachmentCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IssueAttachmentContract" - }, - "description": "Issue Attachment values.", - "readOnly": true - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Issue Attachment list representation." - }, - "IssueAttachmentContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IssueAttachmentContractProperties", - "description": "Properties of the Issue Attachment." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Issue Attachment Contract details." - }, - "IssueAttachmentContractProperties": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Filename by which the binary data will be saved." - }, - "contentFormat": { - "type": "string", - "description": "Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property." - }, - "content": { - "type": "string", - "description": "An HTTP link or Base64-encoded binary data." - } - }, - "required": [ - "title", - "contentFormat", - "content" - ], - "description": "Issue Attachment contract Properties." - }, - "IssueCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IssueContract" - }, - "description": "Issue values.", - "readOnly": true - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Issue list representation." - }, - "IssueCommentCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IssueCommentContract" - }, - "description": "Issue Comment values.", - "readOnly": true - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Issue Comment list representation." - }, - "IssueCommentContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IssueCommentContractProperties", - "description": "Properties of the Issue Comment." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Issue Comment Contract details." - }, - "IssueCommentContractProperties": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "Comment text." - }, - "createdDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the comment was created." - }, - "userId": { - "type": "string", - "description": "A resource identifier for the user who left the comment." - } - }, - "required": [ - "text", - "userId" - ], - "description": "Issue Comment contract Properties." - }, - "IssueContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IssueContractProperties", - "description": "Properties of the Issue." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Issue Contract details." - }, - "IssueContractBaseProperties": { - "type": "object", - "properties": { - "createdDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the issue was created." - }, - "state": { - "type": "string", - "description": "Status of the issue.", - "enum": [ - "proposed", - "open", - "removed", - "resolved", - "closed" - ], - "x-ms-enum": { - "name": "State", - "modelAsString": true, - "values": [ - { - "value": "proposed", - "description": "The issue is proposed." - }, - { - "value": "open", - "description": "The issue is opened." - }, - { - "value": "removed", - "description": "The issue was removed." - }, - { - "value": "resolved", - "description": "The issue is now resolved." - }, - { - "value": "closed", - "description": "The issue was closed." - } - ] - } - }, - "apiId": { - "type": "string", - "description": "A resource identifier for the API the issue was created for." - } - }, - "description": "Issue contract Base Properties." - }, - "IssueContractProperties": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The issue title." - }, - "description": { - "type": "string", - "description": "Text describing the issue." - }, - "userId": { - "type": "string", - "description": "A resource identifier for the user created the issue." - } - }, - "required": [ - "title", - "description", - "userId" - ], - "allOf": [ - { - "$ref": "#/definitions/IssueContractBaseProperties" - } - ], - "description": "Issue contract Properties." - }, - "IssueUpdateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IssueUpdateContractProperties", - "description": "Issue entity Update contract properties." - } - }, - "description": "Issue update Parameters." - }, - "IssueUpdateContractProperties": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The issue title." - }, - "description": { - "type": "string", - "description": "Text describing the issue." - }, - "userId": { - "type": "string", - "description": "A resource identifier for the user created the issue." - } - }, - "allOf": [ - { - "$ref": "#/definitions/IssueContractBaseProperties" - } - ], - "description": "Issue contract Update Properties." - }, - "KeyVaultContractCreateProperties": { - "type": "object", - "properties": { - "secretIdentifier": { - "type": "string", - "description": "Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi" - }, - "identityClientId": { - "type": "string", - "description": "Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret." - } - }, - "description": "Create keyVault contract details." - }, - "KeyVaultContractProperties": { - "type": "object", - "properties": { - "lastStatus": { - "$ref": "#/definitions/KeyVaultLastAccessStatusContractProperties", - "description": "Last time sync and refresh status of secret from key vault." - } - }, - "allOf": [ - { - "$ref": "#/definitions/KeyVaultContractCreateProperties" - } - ], - "description": "KeyVault contract details." - }, - "KeyVaultLastAccessStatusContractProperties": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Last status code for sync and refresh of secret from key vault." - }, - "message": { - "type": "string", - "description": "Details of the error else empty." - }, - "timeStampUtc": { - "type": "string", - "format": "date-time", - "description": "Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - } - }, - "description": "Issue contract Update Properties." - }, - "LoggerCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/LoggerContract" - }, - "description": "Logger values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Logger list representation." - }, - "LoggerContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/LoggerContractProperties", - "description": "Logger entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Logger details." - }, - "LoggerContractProperties": { - "type": "object", - "properties": { - "loggerType": { - "type": "string", - "description": "Logger type.", - "enum": [ - "azureEventHub", - "applicationInsights", - "azureMonitor" - ], - "x-ms-enum": { - "name": "LoggerType", - "modelAsString": true, - "values": [ - { - "value": "azureEventHub", - "description": "Azure Event Hub as log destination." - }, - { - "value": "applicationInsights", - "description": "Azure Application Insights as log destination." - }, - { - "value": "azureMonitor", - "description": "Azure Monitor" - } - ] - } - }, - "description": { - "type": "string", - "description": "Logger description.", - "maxLength": 256 - }, - "credentials": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The name and SendRule connection string of the event hub for azureEventHub logger.\nInstrumentation key for applicationInsights logger.", - "example": { - "name": "apim", - "connectionString": "Endpoint=sb://contoso-ns.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=..." - } - }, - "isBuffered": { - "type": "boolean", - "description": "Whether records are buffered in the logger before publishing. Default is assumed to be true." - }, - "resourceId": { - "type": "string", - "description": "Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource)." - } - }, - "required": [ - "loggerType" - ], - "description": "The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs." - }, - "LoggerUpdateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/LoggerUpdateParameters", - "description": "Logger entity update contract properties." - } - }, - "description": "Logger update contract." - }, - "LoggerUpdateParameters": { - "type": "object", - "properties": { - "loggerType": { - "type": "string", - "description": "Logger type.", - "enum": [ - "azureEventHub", - "applicationInsights", - "azureMonitor" - ], - "x-ms-enum": { - "name": "LoggerType", - "modelAsString": true, - "values": [ - { - "value": "azureEventHub", - "description": "Azure Event Hub as log destination." - }, - { - "value": "applicationInsights", - "description": "Azure Application Insights as log destination." - }, - { - "value": "azureMonitor", - "description": "Azure Monitor" - } - ] - } - }, - "description": { - "type": "string", - "description": "Logger description." - }, - "credentials": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Logger credentials." - }, - "isBuffered": { - "type": "boolean", - "description": "Whether records are buffered in the logger before publishing. Default is assumed to be true." - } - }, - "description": "Parameters supplied to the Update Logger operation." - }, - "NotificationCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/NotificationContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Notification list representation." - }, - "NotificationContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/NotificationContractProperties", - "description": "Notification entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Notification details." - }, - "NotificationContractProperties": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the Notification.", - "minLength": 1, - "maxLength": 1000 - }, - "description": { - "type": "string", - "description": "Description of the Notification." - }, - "recipients": { - "$ref": "#/definitions/RecipientsContractProperties", - "description": "Recipient Parameter values." - } - }, - "required": [ - "title" - ], - "description": "Notification Contract properties." - }, - "OAuth2AuthenticationSettingsContract": { - "type": "object", - "properties": { - "authorizationServerId": { - "type": "string", - "description": "OAuth authorization server identifier." - }, - "scope": { - "type": "string", - "description": "operations scope." - } - }, - "description": "API OAuth2 Authentication settings details." - }, - "OpenIdAuthenticationSettingsContract": { - "type": "object", - "properties": { - "openidProviderId": { - "type": "string", - "description": "OAuth authorization server identifier." - }, - "bearerTokenSendingMethods": { - "description": "How to send token to the server.", - "type": "array", - "items": { - "$ref": "#/definitions/BearerTokenSendingMethodsContract" - } - } - }, - "description": "API OAuth2 Authentication settings details." - }, - "OpenIdConnectProviderCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/OpenidConnectProviderContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged OpenIdProviders list representation." - }, - "OpenidConnectProviderContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/OpenidConnectProviderContractProperties", - "description": "OpenId Connect Provider contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "OpenId Connect Provider details." - }, - "OpenidConnectProviderContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "User-friendly OpenID Connect Provider name.", - "maxLength": 50 - }, - "description": { - "type": "string", - "description": "User-friendly description of OpenID Connect Provider." - }, - "metadataEndpoint": { - "type": "string", - "description": "Metadata endpoint URI." - }, - "clientId": { - "type": "string", - "description": "Client ID of developer console which is the client application." - }, - "clientSecret": { - "x-ms-secret": true, - "type": "string", - "description": "Client Secret of developer console which is the client application." - }, - "useInTestConsole": { - "type": "boolean", - "description": "If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided." - }, - "useInApiDocumentation": { - "type": "boolean", - "description": "If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided." - } - }, - "required": [ - "displayName", - "metadataEndpoint", - "clientId" - ], - "description": "OpenID Connect Providers Contract." - }, - "OpenidConnectProviderUpdateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/OpenidConnectProviderUpdateContractProperties", - "description": "OpenId Connect Provider Update contract properties." - } - }, - "description": "Parameters supplied to the Update OpenID Connect Provider operation." - }, - "OpenidConnectProviderUpdateContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "User-friendly OpenID Connect Provider name.", - "maxLength": 50 - }, - "description": { - "type": "string", - "description": "User-friendly description of OpenID Connect Provider." - }, - "metadataEndpoint": { - "type": "string", - "description": "Metadata endpoint URI." - }, - "clientId": { - "type": "string", - "description": "Client ID of developer console which is the client application." - }, - "clientSecret": { - "x-ms-secret": true, - "type": "string", - "description": "Client Secret of developer console which is the client application." - }, - "useInTestConsole": { - "type": "boolean", - "description": "If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided." - }, - "useInApiDocumentation": { - "type": "boolean", - "description": "If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided." - } - }, - "description": "Parameters supplied to the Update OpenID Connect Provider operation." - }, - "OperationCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/OperationContract" - }, - "description": "Page values.", - "readOnly": true - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Operation list representation." - }, - "OperationContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/OperationContractProperties", - "description": "Properties of the Operation Contract." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "API Operation details." - }, - "OperationContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Operation Name.", - "minLength": 1, - "maxLength": 300 - }, - "method": { - "type": "string", - "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.", - "externalDocs": { - "description": "As defined by RFC.", - "url": "http://www.rfc-editor.org/rfc/rfc7230.txt" - } - }, - "urlTemplate": { - "type": "string", - "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", - "minLength": 1, - "maxLength": 1000 - } - }, - "allOf": [ - { - "$ref": "#/definitions/OperationEntityBaseContract" - } - ], - "required": [ - "displayName", - "method", - "urlTemplate" - ], - "description": "Operation Contract Properties" - }, - "OperationEntityBaseContract": { - "type": "object", - "properties": { - "templateParameters": { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - }, - "x-ms-identifiers": [ - "name", - "type" - ], - "description": "Collection of URL template parameters." - }, - "description": { - "type": "string", - "description": "Description of the operation. May include HTML formatting tags.", - "maxLength": 1000 - }, - "request": { - "$ref": "#/definitions/RequestContract", - "description": "An entity containing request details." - }, - "responses": { - "type": "array", - "items": { - "$ref": "#/definitions/ResponseContract" - }, - "x-ms-identifiers": [], - "description": "Array of Operation responses." - }, - "policies": { - "type": "string", - "description": "Operation Policies" - } - }, - "description": "API Operation Entity Base Contract details." - }, - "OperationResultContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/OperationResultContractProperties", - "description": "Properties of the Operation Contract." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Long Running Git Operation Results." - }, - "OperationResultContractProperties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Operation result identifier." - }, - "status": { - "type": "string", - "description": "Status of an async operation.", - "enum": [ - "Started", - "InProgress", - "Succeeded", - "Failed" - ], - "x-ms-enum": { - "name": "AsyncOperationStatus", - "modelAsString": false - } - }, - "started": { - "type": "string", - "format": "date-time", - "description": "Start time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "updated": { - "type": "string", - "format": "date-time", - "description": "Last update time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "resultInfo": { - "type": "string", - "description": "Optional result info." - }, - "error": { - "$ref": "./apimanagement.json#/definitions/ErrorResponseBody", - "description": "Error Body Contract" - }, - "actionLog": { - "type": "array", - "items": { - "$ref": "#/definitions/OperationResultLogItemContract" - }, - "x-ms-identifiers": [ - "objectKey" - ], - "readOnly": true, - "description": "This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation." - } - }, - "description": "Operation Result." - }, - "OperationResultLogItemContract": { - "type": "object", - "properties": { - "objectType": { - "type": "string", - "description": "The type of entity contract." - }, - "action": { - "type": "string", - "description": "Action like create/update/delete." - }, - "objectKey": { - "type": "string", - "description": "Identifier of the entity being created/updated/deleted." - } - }, - "description": "Log of the entity being created, updated or deleted." - }, - "OperationTagResourceContractProperties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Identifier of the operation in form /operations/{operationId}." - }, - "name": { - "type": "string", - "description": "Operation name.", - "readOnly": true - }, - "apiName": { - "type": "string", - "description": "API Name.", - "readOnly": true - }, - "apiRevision": { - "type": "string", - "description": "API Revision.", - "readOnly": true - }, - "apiVersion": { - "type": "string", - "description": "API Version.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "Operation Description.", - "readOnly": true - }, - "method": { - "type": "string", - "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.", - "externalDocs": { - "description": "As defined by RFC.", - "url": "http://www.rfc-editor.org/rfc/rfc7230.txt" - }, - "readOnly": true - }, - "urlTemplate": { - "type": "string", - "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", - "readOnly": true - } - }, - "description": "Operation Entity contract Properties." - }, - "OperationUpdateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/OperationUpdateContractProperties", - "description": "Properties of the API Operation entity that can be updated." - } - }, - "description": "API Operation Update Contract details." - }, - "OperationUpdateContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Operation Name.", - "minLength": 1, - "maxLength": 300 - }, - "method": { - "type": "string", - "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.", - "externalDocs": { - "description": "As defined by RFC.", - "url": "http://www.rfc-editor.org/rfc/rfc7230.txt" - } - }, - "urlTemplate": { - "type": "string", - "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", - "minLength": 1, - "maxLength": 1000 - } - }, - "allOf": [ - { - "$ref": "#/definitions/OperationEntityBaseContract" - } - ], - "description": "Operation Update Contract Properties." - }, - "ParameterContract": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Parameter name." - }, - "description": { - "type": "string", - "description": "Parameter description." - }, - "type": { - "type": "string", - "description": "Parameter type." - }, - "defaultValue": { - "type": "string", - "description": "Default parameter value." - }, - "required": { - "type": "boolean", - "description": "Specifies whether parameter is required or not." - }, - "values": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Parameter values." - }, - "schemaId": { - "type": "string", - "description": "Schema identifier." - }, - "typeName": { - "type": "string", - "description": "Type name defined by the schema." - }, - "examples": { - "$ref": "#/definitions/ParameterExamplesContract", - "description": "Exampled defined for the parameter." - } - }, - "required": [ - "name", - "type" - ], - "description": "Operation parameters details." - }, - "ParameterExamplesContract": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ParameterExampleContract", - "description": "Parameter example." - }, - "description": "Parameter examples." - }, - "ParameterExampleContract": { - "type": "object", - "description": "Parameter example.", - "properties": { - "summary": { - "type": "string", - "description": "Short description for the example" - }, - "description": { - "type": "string", - "description": "Long description for the example" - }, - "value": { - "description": "Example value. May be a primitive value, or an object." - }, - "externalValue": { - "type": "string", - "description": "A URL that points to the literal example" - } - } - }, - "LLMDiagnosticSettings": { - "type": "object", - "description": "Diagnostic settings for Large Language Models", - "properties": { - "logs": { - "$ref": "#/definitions/LLMLogsTypes", - "description": "Specifies whether default diagnostic should be enabled for Large Language Models or not." - }, - "requests": { - "$ref": "#/definitions/LLMMessageDiagnosticSettings", - "description": "Diagnostic settings for Large Language Models requests." - }, - "responses": { - "$ref": "#/definitions/LLMMessageDiagnosticSettings", - "description": "Diagnostic settings for Large Language Models responses." - } - } - }, - "LLMLogsTypes": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "llm-diagnostic-settings", - "values": [ - { - "value": "enabled", - "description": "Default LLM logs are enabled." - }, - { - "value": "disabled", - "description": "Default LLM logs are disabled." - } - ] - } - }, - "LLMMessageDiagnosticSettings": { - "type": "object", - "description": "Diagnostic settings for Large Language Models Messages", - "properties": { - "messages": { - "$ref": "#/definitions/LLMMessageLogTypes", - "description": "Specifies which message should be logged. Currently there is only 'all' option." - }, - "maxSizeInBytes": { - "type": "integer", - "format": "int32", - "description": "Maximum size of message to logs in bytes. The default size is 32KB.", - "minimum": 1, - "maximum": 262144 - } - } - }, - "LLMMessageLogTypes": { - "type": "string", - "enum": [ - "all" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "llm-message-log-types", - "values": [ - { - "value": "all", - "description": "Log all messages." - } - ] - } - }, - "PipelineDiagnosticSettings": { - "type": "object", - "properties": { - "request": { - "$ref": "#/definitions/HttpMessageDiagnostic", - "description": "Diagnostic settings for request." - }, - "response": { - "$ref": "#/definitions/HttpMessageDiagnostic", - "description": "Diagnostic settings for response." - } - }, - "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." - }, - "PolicyCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PolicyContract" - }, - "description": "Policy Contract value." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "The response of the list policy operation." - }, - "PolicyContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PolicyContractProperties", - "description": "Properties of the Policy." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Policy Contract details." - }, - "PolicyContractProperties": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "Contents of the Policy as defined by the format." - }, - "format": { - "type": "string", - "description": "Format of the policyContent.", - "enum": [ - "xml", - "xml-link", - "rawxml", - "rawxml-link" - ], - "x-ms-enum": { - "name": "PolicyContentFormat", - "modelAsString": true, - "values": [ - { - "value": "xml", - "description": "The contents are inline and Content type is an XML document." - }, - { - "value": "xml-link", - "description": "The policy XML document is hosted on a HTTP endpoint accessible from the API Management service." - }, - { - "value": "rawxml", - "description": "The contents are inline and Content type is a non XML encoded policy document." - }, - { - "value": "rawxml-link", - "description": "The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service." - } - ] - }, - "default": "xml" - } - }, - "required": [ - "value" - ], - "description": "Policy contract Properties." - }, - "PolicyWithComplianceCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PolicyWithComplianceContract" - }, - "description": "Policy Contract value." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "The response of the list policy operation." - }, - "PolicyWithComplianceContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PolicyWithComplianceContractProperties", - "description": "Properties of the Policy." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Policy Contract details." - }, - "PolicyWithComplianceContractProperties": { - "type": "object", - "properties": { - "referencePolicyId": { - "type": "string", - "description": "Policy Identifier" - }, - "complianceState": { - "type": "string", - "description": "Policy Restriction Compliance State", - "enum": [ - "Pending", - "NonCompliant", - "Compliant" - ], - "x-ms-enum": { - "name": "PolicyComplianceState", - "modelAsString": true, - "values": [ - { - "value": "Pending", - "description": "The policy restriction compliance state has not yet been determined." - }, - { - "value": "NonCompliant", - "description": "The scope in restriction is out of compliance." - }, - { - "value": "Compliant", - "description": "The scope in restriction is in compliance." - } - ] - }, - "default": "Pending" - } - }, - "description": "Policy contract Properties." - }, - "PolicyDescriptionContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PolicyDescriptionContractProperties", - "description": "Policy description contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Policy description details." - }, - "PolicyDescriptionContractProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Policy description.", - "readOnly": true - }, - "scope": { - "type": "integer", - "format": "int64", - "description": "Binary OR value of the Snippet scope.", - "readOnly": true - } - }, - "description": "Policy description properties." - }, - "PolicyDescriptionCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PolicyDescriptionContract" - }, - "description": "Descriptions of API Management policies." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number." - } - }, - "description": "Descriptions of API Management policies." - }, - "PolicyFragmentCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PolicyFragmentContract" - }, - "description": "Policy fragment contract value." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "The response of the get policy fragments operation." - }, - "PolicyFragmentContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PolicyFragmentContractProperties", - "description": "Properties of the Policy Fragment." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Policy fragment contract details." - }, - "PolicyFragmentContractProperties": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "Contents of the policy fragment." - }, - "description": { - "type": "string", - "description": "Policy fragment description.", - "minLength": 0, - "maxLength": 1000 - }, - "format": { - "type": "string", - "description": "Format of the policy fragment content.", - "enum": [ - "xml", - "rawxml" - ], - "x-ms-enum": { - "name": "PolicyFragmentContentFormat", - "modelAsString": true, - "values": [ - { - "value": "xml", - "description": "The contents are inline and Content type is an XML document." - }, - { - "value": "rawxml", - "description": "The contents are inline and Content type is a non XML encoded policy document." - } - ] - }, - "default": "xml" - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "The provisioning state" - } - }, - "required": [ - "value" - ], - "description": "Policy fragment contract properties." - }, - "PolicyRestrictionCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PolicyRestrictionContract" - } - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "The response of the get policy restrictions operation." - }, - "PolicyRestrictionUpdateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PolicyRestrictionContractProperties", - "description": "Properties of the Policy Restriction." - } - }, - "description": "Policy restriction contract details." - }, - "PolicyRestrictionContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PolicyRestrictionContractProperties", - "description": "Properties of the Policy Restriction." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Policy restriction contract details." - }, - "PolicyRestrictionContractProperties": { - "type": "object", - "properties": { - "scope": { - "type": "string", - "description": "Path to the policy document." - }, - "requireBase": { - "type": "string", - "description": "Indicates if base policy should be enforced for the policy document.", - "enum": [ - "true", - "false" - ], - "x-ms-enum": { - "name": "PolicyRestrictionRequireBase", - "modelAsString": true, - "values": [ - { - "value": "true", - "description": "The policy is required to have base policy" - }, - { - "value": "false", - "description": "The policy does not require to have base policy" - } - ] - }, - "default": "false" - } - }, - "description": "Policy restrictions contract properties." - }, - "AllPoliciesCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AllPoliciesContract" - }, - "description": "AllPolicies Contract value." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "The response of All Policies." - }, - "AllPoliciesContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AllPoliciesContractProperties", - "description": "Properties of the All Policies." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "AllPolicies Contract details." - }, - "AllPoliciesContractProperties": { - "type": "object", - "properties": { - "referencePolicyId": { - "type": "string", - "description": "Policy Identifier" - }, - "complianceState": { - "type": "string", - "description": "Policy Restriction Compliance State", - "enum": [ - "Pending", - "NonCompliant", - "Compliant" - ], - "x-ms-enum": { - "name": "PolicyComplianceState", - "modelAsString": true, - "values": [ - { - "value": "Pending", - "description": "The policy restriction compliance state has not yet been determined." - }, - { - "value": "NonCompliant", - "description": "The scope in restriction is out of compliance." - }, - { - "value": "Compliant", - "description": "The scope in restriction is in compliance." - } - ] - }, - "default": "Pending" - } - }, - "description": "AllPolicies Properties." - }, - "ResourceCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ] - }, - "description": "A collection of resources." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "A collection of resources." - }, - "PortalConfigCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PortalConfigContract" - }, - "description": "The developer portal configurations." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "The collection of the developer portal configurations." - }, - "PortalConfigContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PortalConfigProperties", - "description": "The developer portal configuration contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "The developer portal configuration contract." - }, - "PortalConfigProperties": { - "type": "object", - "properties": { - "enableBasicAuth": { - "type": "boolean", - "description": "Enable or disable Basic authentication method.", - "default": true - }, - "signin": { - "type": "object", - "properties": { - "require": { - "type": "boolean", - "description": "Redirect anonymous users to the sign-in page.", - "default": false - } - } - }, - "signup": { - "type": "object", - "properties": { - "termsOfService": { - "type": "object", - "$ref": "#/definitions/PortalConfigTermsOfServiceProperties", - "description": "Terms of service settings." - } - } - }, - "delegation": { - "type": "object", - "$ref": "#/definitions/PortalConfigDelegationProperties", - "description": "The developer portal delegation settings." - }, - "cors": { - "type": "object", - "$ref": "#/definitions/PortalConfigCorsProperties", - "description": "The developer portal Cross-Origin Resource Sharing (CORS) settings." - }, - "csp": { - "type": "object", - "$ref": "#/definitions/PortalConfigCspProperties", - "description": "The developer portal Content Security Policy (CSP) settings." - } - }, - "description": "The developer portal configuration contract properties." - }, - "PortalConfigDelegationProperties": { - "type": "object", - "properties": { - "delegateRegistration": { - "type": "boolean", - "description": "Enable or disable delegation for user registration.", - "default": false - }, - "delegateSubscription": { - "type": "boolean", - "description": "Enable or disable delegation for product subscriptions.", - "default": false - }, - "delegationUrl": { - "type": "string", - "description": "A delegation endpoint URL." - }, - "validationKey": { - "x-ms-secret": true, - "type": "string", - "description": "A base64-encoded validation key to ensure requests originate from Azure API Management service." - } - } - }, - "PortalConfigTermsOfServiceProperties": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "A terms of service text." - }, - "requireConsent": { - "type": "boolean", - "description": "Ask user for consent to the terms of service.", - "default": false - } - }, - "description": "Terms of service contract properties." - }, - "PortalConfigCorsProperties": { - "type": "object", - "properties": { - "allowedOrigins": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Allowed origins, e.g. `https://trusted.com`." - } - }, - "description": "The developer portal Cross-Origin Resource Sharing (CORS) settings." - }, - "PortalConfigCspProperties": { - "type": "object", - "properties": { - "mode": { - "type": "string", - "description": "The mode of the developer portal Content Security Policy (CSP).", - "enum": [ - "enabled", - "disabled", - "reportOnly" - ], - "default": "disabled", - "x-ms-enum": { - "modelAsString": true, - "name": "PortalSettingsCspMode", - "values": [ - { - "value": "enabled", - "description": "The browser will block requests not matching allowed origins." - }, - { - "value": "disabled", - "description": "The browser will not apply the origin restrictions." - }, - { - "value": "reportOnly", - "description": "The browser will report requests not matching allowed origins without blocking them." - } - ] - } - }, - "reportUri": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The URLs used by the browser to report CSP violations." - }, - "allowedSources": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Allowed sources, e.g. `*.trusted.com`, `trusted.com`, `https://`." - } - }, - "description": "The developer portal Content Security Policy (CSP) settings." - }, - "PortalDelegationSettings": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PortalDelegationSettingsProperties", - "description": "Delegation settings contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Delegation settings for a developer portal." - }, - "PortalDelegationSettingsProperties": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "A delegation Url." - }, - "validationKey": { - "x-ms-secret": true, - "type": "string", - "description": "A base64-encoded validation key to validate, that a request is coming from Azure API Management." - }, - "subscriptions": { - "$ref": "#/definitions/SubscriptionsDelegationSettingsProperties", - "description": "Subscriptions delegation settings." - }, - "userRegistration": { - "$ref": "#/definitions/RegistrationDelegationSettingsProperties", - "description": "User registration delegation settings." - } - }, - "description": "Delegation settings contract properties." - }, - "PortalSettingsCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PortalSettingsContract" - }, - "description": "Descriptions of API Management policies." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number." - } - }, - "description": "Descriptions of API Management policies." - }, - "PortalSettingsContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PortalSettingsContractProperties", - "description": "Portal Settings contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Portal Settings for the Developer Portal." - }, - "PortalSettingsContractProperties": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "A delegation Url." - }, - "validationKey": { - "x-ms-secret": true, - "type": "string", - "description": "A base64-encoded validation key to validate, that a request is coming from Azure API Management." - }, - "subscriptions": { - "$ref": "#/definitions/SubscriptionsDelegationSettingsProperties", - "description": "Subscriptions delegation settings." - }, - "userRegistration": { - "$ref": "#/definitions/RegistrationDelegationSettingsProperties", - "description": "User registration delegation settings." - }, - "enabled": { - "type": "boolean", - "description": "Redirect Anonymous users to the Sign-In page." - }, - "termsOfService": { - "type": "object", - "$ref": "#/definitions/TermsOfServiceProperties", - "description": "Terms of service contract properties." - } - }, - "description": "Sign-in settings contract properties." - }, - "PortalSigninSettingProperties": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Redirect Anonymous users to the Sign-In page." - } - }, - "description": "Sign-in settings contract properties." - }, - "PortalSigninSettings": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PortalSigninSettingProperties", - "description": "Sign-in settings contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Sign-In settings for the Developer Portal." - }, - "PortalSignupSettings": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PortalSignupSettingsProperties", - "description": "Sign-up settings contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Sign-Up settings for a developer portal." - }, - "PortalSignupSettingsProperties": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Allow users to sign up on a developer portal." - }, - "termsOfService": { - "type": "object", - "$ref": "#/definitions/TermsOfServiceProperties", - "description": "Terms of service contract properties." - } - }, - "description": "Sign-up settings contract properties." - }, - "ProductCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ProductContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Products list representation." - }, - "ProductContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ProductContractProperties", - "description": "Product entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Product details." - }, - "ProductContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Product name.", - "minLength": 1, - "maxLength": 300 - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProductEntityBaseParameters" - } - ], - "required": [ - "displayName" - ], - "description": "Product profile." - }, - "ProductEntityBaseParameters": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Product description. May include HTML formatting tags.", - "minLength": 0, - "maxLength": 1000 - }, - "terms": { - "type": "string", - "description": "Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process." - }, - "subscriptionRequired": { - "description": "Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as \"protected\" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as \"open\" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.", - "type": "boolean" - }, - "approvalRequired": { - "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.", - "type": "boolean" - }, - "subscriptionsLimit": { - "type": "integer", - "format": "int32", - "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." - }, - "authenticationType": { - "type": "array", - "description": "Type of supported authentication for the product. The application configuration is required for application-token authentication type. The subscription-key authentication type is used by default. If the property is omitted, the subscription-key authentication type is used.", - "items": { - "type": "string", - "enum": [ - "subscription-key", - "application-token" - ], - "x-ms-enum": { - "name": "ProductAuthType", - "modelAsString": true - } - } - }, - "application": { - "type": "object", - "description": "Specifies identity provider settings needed to authorize applications API calls.", - "allOf": [ - { - "$ref": "#/definitions/ProductApplicationContract" - } - ] - }, - "state": { - "type": "string", - "description": "whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.", - "enum": [ - "notPublished", - "published" - ], - "x-ms-enum": { - "name": "ProductState", - "modelAsString": false - } - } - }, - "description": "Product Entity Base Parameters" - }, - "ProductTagResourceContractProperties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Identifier of the product in the form of /products/{productId}" - }, - "name": { - "type": "string", - "description": "Product name.", - "minLength": 1, - "maxLength": 300 - } - }, - "allOf": [ - { - "$ref": "./definitions.json#/definitions/ProductEntityBaseParameters" - } - ], - "required": [ - "name" - ], - "description": "Product profile." - }, - "ProductUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ProductUpdateProperties", - "description": "Product entity Update contract properties." - } - }, - "description": "Product Update parameters." - }, - "ProductUpdateProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Product name.", - "maxLength": 300, - "minLength": 1 - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProductEntityBaseParameters" - } - ], - "description": "Parameters supplied to the Update Product operation." - }, - "ProductApplicationContract": { - "type": "object", - "description": "Specifies Microsoft Entra settings needed to authorize product API calls using client applications.", - "properties": { - "entra": { - "type": "object", - "description": "Specifies Microsoft Entra settings needed to authorize product API calls using client application with Microsoft Entra OAuth token.", - "properties": { - "applicationId": { - "type": "string", - "description": "Product facing EntraID application client ID." - }, - "audience": { - "type": "string", - "description": "The EntraID application audience claim. The audience claim is used to validate the token." - } - } - } - } - }, - "NamedValueCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/NamedValueContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged NamedValue list representation." - }, - "NamedValueCreateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/NamedValueCreateContractProperties", - "description": "NamedValue entity contract properties for PUT operation." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "NamedValue details." - }, - "NamedValueCreateContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[A-Za-z0-9-._]+$" - }, - "value": { - "type": "string", - "description": "Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", - "maxLength": 4096 - }, - "keyVault": { - "$ref": "#/definitions/KeyVaultContractCreateProperties", - "description": "KeyVault location details of the namedValue." - } - }, - "allOf": [ - { - "$ref": "#/definitions/NamedValueEntityBaseParameters" - } - ], - "required": [ - "displayName" - ], - "description": "NamedValue Contract properties." - }, - "NamedValueContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/NamedValueContractProperties", - "description": "NamedValue entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "NamedValue details." - }, - "NamedValueContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[A-Za-z0-9-._]+$" - }, - "value": { - "type": "string", - "description": "Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", - "maxLength": 4096 - }, - "keyVault": { - "$ref": "#/definitions/KeyVaultContractProperties", - "description": "KeyVault location details of the namedValue." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "The provisioning state" - } - }, - "allOf": [ - { - "$ref": "#/definitions/NamedValueEntityBaseParameters" - } - ], - "required": [ - "displayName" - ], - "description": "NamedValue Contract properties." - }, - "NamedValueEntityBaseParameters": { - "type": "object", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - }, - "maxItems": 32, - "description": "Optional tags that when provided can be used to filter the NamedValue list." - }, - "secret": { - "description": "Determines whether the value is a secret and should be encrypted or not. Default value is false.", - "type": "boolean" - } - }, - "description": "NamedValue Entity Base Parameters set." - }, - "NamedValueUpdateParameterProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[A-Za-z0-9-._]+$" - }, - "value": { - "type": "string", - "description": "Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace.", - "minLength": 1, - "maxLength": 4096 - }, - "keyVault": { - "$ref": "#/definitions/KeyVaultContractCreateProperties", - "description": "KeyVault location details of the namedValue." - } - }, - "allOf": [ - { - "$ref": "#/definitions/NamedValueEntityBaseParameters" - } - ], - "description": "NamedValue Contract properties." - }, - "NamedValueUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/NamedValueUpdateParameterProperties", - "description": "NamedValue entity Update contract properties." - } - }, - "description": "NamedValue update Parameters." - }, - "QuotaCounterCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/QuotaCounterContract" - }, - "x-ms-identifiers": [ - "counterKey", - "periodKey" - ], - "description": "Quota counter values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Quota Counter list representation." - }, - "QuotaCounterContract": { - "type": "object", - "properties": { - "counterKey": { - "type": "string", - "description": "The Key value of the Counter. Must not be empty.", - "minLength": 1 - }, - "periodKey": { - "type": "string", - "description": "Identifier of the Period for which the counter was collected. Must not be empty.", - "minLength": 1 - }, - "periodStartTime": { - "type": "string", - "format": "date-time", - "description": "The date of the start of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "periodEndTime": { - "type": "string", - "format": "date-time", - "description": "The date of the end of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "value": { - "$ref": "#/definitions/QuotaCounterValueContractProperties", - "description": "Quota Value Properties" - } - }, - "required": [ - "counterKey", - "periodKey", - "periodStartTime", - "periodEndTime" - ], - "description": "Quota counter details." - }, - "QuotaCounterValueContract": { - "type": "object", - "properties": { - "value": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/QuotaCounterValueContractProperties", - "description": "Quota counter Value Properties." - } - }, - "description": "Quota counter value details." - }, - "QuotaCounterValueContractProperties": { - "type": "object", - "properties": { - "callsCount": { - "type": "integer", - "format": "int32", - "description": "Number of times Counter was called." - }, - "kbTransferred": { - "type": "number", - "format": "double", - "description": "Data Transferred in KiloBytes." - } - }, - "description": "Quota counter value details." - }, - "QuotaCounterValueUpdateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/QuotaCounterValueContractProperties", - "description": "Quota counter value details." - } - }, - "description": "Quota counter value details." - }, - "RecipientEmailCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RecipientEmailContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Recipient User list representation." - }, - "RecipientEmailContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/RecipientEmailContractProperties", - "description": "Recipient Email contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Recipient Email details." - }, - "RecipientEmailContractProperties": { - "type": "object", - "properties": { - "email": { - "type": "string", - "description": "User Email subscribed to notification." - } - }, - "description": "Recipient Email Contract Properties." - }, - "RecipientsContractProperties": { - "type": "object", - "properties": { - "emails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of Emails subscribed for the notification." - }, - "users": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of Users subscribed for the notification." - } - }, - "description": "Notification Parameter contract." - }, - "RecipientUserCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RecipientUserContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Recipient User list representation." - }, - "RecipientUserContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/RecipientUsersContractProperties", - "description": "Recipient User entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Recipient User details." - }, - "RecipientUsersContractProperties": { - "type": "object", - "properties": { - "userId": { - "type": "string", - "description": "API Management UserId subscribed to notification." - } - }, - "description": "Recipient User Contract Properties." - }, - "RegistrationDelegationSettingsProperties": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable or disable delegation for user registration." - } - }, - "description": "User registration delegation settings properties." - }, - "ReportCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ReportRecordContract" - }, - "x-ms-identifiers": [ - "name", - "userId" - ], - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Report records list representation." - }, - "ReportRecordContract": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name depending on report endpoint specifies product, API, operation or developer name." - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "interval": { - "type": "string", - "description": "Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations)." - }, - "country": { - "type": "string", - "description": "Country to which this record data is related." - }, - "region": { - "type": "string", - "description": "Country region to which this record data is related." - }, - "zip": { - "type": "string", - "description": "Zip code to which this record data is related." - }, - "userId": { - "readOnly": true, - "type": "string", - "description": "User identifier path. /users/{userId}" - }, - "productId": { - "readOnly": true, - "type": "string", - "description": "Product identifier path. /products/{productId}" - }, - "apiId": { - "type": "string", - "description": "API identifier path. /apis/{apiId}" - }, - "operationId": { - "type": "string", - "description": "Operation identifier path. /apis/{apiId}/operations/{operationId}" - }, - "apiRegion": { - "type": "string", - "description": "API region identifier." - }, - "subscriptionId": { - "type": "string", - "description": "Subscription identifier path. /subscriptions/{subscriptionId}" - }, - "callCountSuccess": { - "type": "integer", - "format": "int32", - "description": "Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" - }, - "callCountBlocked": { - "type": "integer", - "format": "int32", - "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" - }, - "callCountFailed": { - "type": "integer", - "format": "int32", - "description": "Number of calls failed due to gateway or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600" - }, - "callCountOther": { - "type": "integer", - "format": "int32", - "description": "Number of other calls." - }, - "callCountTotal": { - "type": "integer", - "format": "int32", - "description": "Total number of calls." - }, - "bandwidth": { - "type": "integer", - "format": "int64", - "description": "Bandwidth consumed." - }, - "cacheHitCount": { - "type": "integer", - "format": "int32", - "description": "Number of times when content was served from cache policy." - }, - "cacheMissCount": { - "type": "integer", - "format": "int32", - "description": "Number of times content was fetched from backend." - }, - "apiTimeAvg": { - "type": "number", - "format": "double", - "description": "Average time it took to process request." - }, - "apiTimeMin": { - "type": "number", - "format": "double", - "description": "Minimum time it took to process request." - }, - "apiTimeMax": { - "type": "number", - "format": "double", - "description": "Maximum time it took to process request." - }, - "serviceTimeAvg": { - "type": "number", - "format": "double", - "description": "Average time it took to process request on backend." - }, - "serviceTimeMin": { - "type": "number", - "format": "double", - "description": "Minimum time it took to process request on backend." - }, - "serviceTimeMax": { - "type": "number", - "format": "double", - "description": "Maximum time it took to process request on backend." - } - }, - "description": "Report data." - }, - "RepresentationContract": { - "type": "object", - "properties": { - "contentType": { - "type": "string", - "description": "Specifies a registered or custom content type for this representation, e.g. application/xml." - }, - "schemaId": { - "type": "string", - "description": "Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." - }, - "typeName": { - "type": "string", - "description": "Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." - }, - "formParameters": { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - }, - "x-ms-identifiers": [ - "name", - "type" - ], - "description": "Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.." - }, - "examples": { - "$ref": "#/definitions/ParameterExamplesContract", - "description": "Exampled defined for the representation." - } - }, - "required": [ - "contentType" - ], - "description": "Operation request/response representation details." - }, - "RequestContract": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Operation request description." - }, - "queryParameters": { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - }, - "x-ms-identifiers": [ - "name", - "type" - ], - "description": "Collection of operation request query parameters." - }, - "headers": { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - }, - "x-ms-identifiers": [ - "name", - "type" - ], - "description": "Collection of operation request headers." - }, - "representations": { - "type": "array", - "items": { - "$ref": "#/definitions/RepresentationContract" - }, - "x-ms-identifiers": [], - "description": "Collection of operation request representations." - } - }, - "description": "Operation request details." - }, - "RequestReportCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RequestReportRecordContract" - }, - "x-ms-identifiers": [ - "url" - ], - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - } - }, - "description": "Paged Report records list representation." - }, - "RequestReportRecordContract": { - "type": "object", - "properties": { - "apiId": { - "type": "string", - "description": "API identifier path. /apis/{apiId}" - }, - "operationId": { - "type": "string", - "description": "Operation identifier path. /apis/{apiId}/operations/{operationId}" - }, - "productId": { - "readOnly": true, - "type": "string", - "description": "Product identifier path. /products/{productId}" - }, - "userId": { - "readOnly": true, - "type": "string", - "description": "User identifier path. /users/{userId}" - }, - "method": { - "type": "string", - "description": "The HTTP method associated with this request.." - }, - "url": { - "type": "string", - "description": "The full URL associated with this request." - }, - "ipAddress": { - "type": "string", - "description": "The client IP address associated with this request." - }, - "backendResponseCode": { - "type": "string", - "description": "The HTTP status code received by the gateway as a result of forwarding this request to the backend." - }, - "responseCode": { - "type": "integer", - "format": "int32", - "description": "The HTTP status code returned by the gateway." - }, - "responseSize": { - "type": "integer", - "format": "int32", - "description": "The size of the response returned by the gateway." - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The date and time when this request was received by the gateway in ISO 8601 format." - }, - "cache": { - "type": "string", - "description": "Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend." - }, - "apiTime": { - "type": "number", - "format": "double", - "description": "The total time it took to process this request." - }, - "serviceTime": { - "type": "number", - "format": "double", - "description": "he time it took to forward this request to the backend and get the response back." - }, - "apiRegion": { - "type": "string", - "description": "Azure region where the gateway that processed this request is located." - }, - "subscriptionId": { - "type": "string", - "description": "Subscription identifier path. /subscriptions/{subscriptionId}" - }, - "requestId": { - "type": "string", - "description": "Request Identifier." - }, - "requestSize": { - "type": "integer", - "format": "int32", - "description": "The size of this request.." - } - }, - "description": "Request Report data." - }, - "ResolverCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ResolverContract" - }, - "description": "Page values.", - "readOnly": true - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Resolver list representation." - }, - "ResolverContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ResolverEntityBaseContract", - "description": "Properties of the Resolver Contract." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "GraphQL API Resolver details." - }, - "ResolverEntityBaseContract": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Resolver Name.", - "minLength": 1, - "maxLength": 300 - }, - "path": { - "type": "string", - "description": "Path is type/field being resolved.", - "minLength": 1, - "maxLength": 300 - }, - "description": { - "type": "string", - "description": "Description of the resolver. May include HTML formatting tags.", - "maxLength": 1000 - } - }, - "description": "GraphQL API Resolver Entity Base Contract details." - }, - "ResolverResultContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ResolverResultContractProperties", - "description": "Properties of the Resolver Contract." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Long Running Git Resolver Results." - }, - "ResolverResultContractProperties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resolver result identifier." - }, - "status": { - "type": "string", - "description": "Status of an async resolver.", - "enum": [ - "Started", - "InProgress", - "Succeeded", - "Failed" - ], - "x-ms-enum": { - "name": "AsyncResolverStatus", - "modelAsString": false - } - }, - "started": { - "type": "string", - "format": "date-time", - "description": "Start time of an async resolver. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "updated": { - "type": "string", - "format": "date-time", - "description": "Last update time of an async resolver. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "resultInfo": { - "type": "string", - "description": "Optional result info." - }, - "error": { - "$ref": "./apimanagement.json#/definitions/ErrorResponseBody", - "description": "Error Body Contract" - }, - "actionLog": { - "type": "array", - "items": { - "$ref": "#/definitions/ResolverResultLogItemContract" - }, - "x-ms-identifiers": [ - "objectKey" - ], - "readOnly": true, - "description": "This property if only provided as part of the TenantConfiguration_Validate resolver. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy resolver." - } - }, - "description": "Resolver Result." - }, - "ResolverResultLogItemContract": { - "type": "object", - "properties": { - "objectType": { - "type": "string", - "description": "The type of entity contract." - }, - "action": { - "type": "string", - "description": "Action like create/update/delete." - }, - "objectKey": { - "type": "string", - "description": "Identifier of the entity being created/updated/deleted." - } - }, - "description": "Log of the entity being created, updated or deleted." - }, - "ResolverUpdateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ResolverUpdateContractProperties", - "description": "Properties of the GraphQL API Resolver entity that can be updated." - } - }, - "description": "GraphQL API Resolver Update Contract details." - }, - "ResolverUpdateContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Resolver Name.", - "minLength": 1, - "maxLength": 300 - }, - "path": { - "type": "string", - "description": "Path is type/field being resolved.", - "minLength": 1, - "maxLength": 300 - }, - "description": { - "type": "string", - "description": "Description of the resolver. May include HTML formatting tags.", - "maxLength": 1000 - } - }, - "description": "Resolver Update Contract Properties." - }, - "ResponseContract": { - "type": "object", - "properties": { - "statusCode": { - "type": "integer", - "format": "int32", - "description": "Operation response HTTP status code." - }, - "description": { - "type": "string", - "description": "Operation response description." - }, - "representations": { - "type": "array", - "items": { - "$ref": "#/definitions/RepresentationContract" - }, - "x-ms-identifiers": [], - "description": "Collection of operation response representations." - }, - "headers": { - "type": "array", - "items": { - "$ref": "#/definitions/ParameterContract" - }, - "x-ms-identifiers": [ - "name", - "type" - ], - "description": "Collection of operation response headers." - } - }, - "required": [ - "statusCode" - ], - "description": "Operation response details." - }, - "SamplingSettings": { - "type": "object", - "properties": { - "samplingType": { - "type": "string", - "description": "Sampling type.", - "enum": [ - "fixed" - ], - "x-ms-enum": { - "name": "SamplingType", - "modelAsString": true, - "values": [ - { - "value": "fixed", - "description": "Fixed-rate sampling." - } - ] - } - }, - "percentage": { - "type": "number", - "format": "double", - "minimum": 0, - "maximum": 100, - "description": "Rate of sampling for fixed-rate sampling." - } - }, - "description": "Sampling settings for Diagnostic." - }, - "SaveConfigurationParameter": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SaveConfigurationParameterProperties", - "description": "Properties of the Save Configuration Parameters." - } - }, - "description": "Save Tenant Configuration Contract details." - }, - "SaveConfigurationParameterProperties": { - "type": "object", - "properties": { - "branch": { - "type": "string", - "description": "The name of the Git branch in which to commit the current configuration snapshot." - }, - "force": { - "type": "boolean", - "description": "The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten." - } - }, - "required": [ - "branch" - ], - "description": "Parameters supplied to the Save Tenant Configuration operation." - }, - "SchemaCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SchemaContract" - }, - "description": "API Schema Contract value.", - "readOnly": true - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "The response of the list schema operation." - }, - "SchemaContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SchemaContractProperties", - "description": "Properties of the API Schema." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "API Schema Contract details." - }, - "SchemaContractProperties": { - "type": "object", - "properties": { - "contentType": { - "type": "string", - "description": "Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`." - }, - "document": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SchemaDocumentProperties", - "description": "Create or update Properties of the API Schema Document." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "The provisioning state" - } - }, - "required": [ - "contentType", - "document" - ], - "description": "API Schema create or update contract Properties." - }, - "SchemaDocumentProperties": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI." - }, - "definitions": { - "type": "object", - "description": "Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise." - }, - "components": { - "type": "object", - "description": "Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise." - } - }, - "description": "Api Schema Document Properties." - }, - "GlobalSchemaCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/GlobalSchemaContract" - }, - "description": "Global Schema Contract value.", - "readOnly": true - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "The response of the list schema operation." - }, - "GlobalSchemaContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/GlobalSchemaContractProperties", - "description": "Properties of the Global Schema." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Global Schema Contract details." - }, - "GlobalSchemaContractProperties": { - "type": "object", - "properties": { - "schemaType": { - "type": "string", - "description": "Schema Type. Immutable.", - "enum": [ - "xml", - "json" - ], - "x-ms-client-name": "SchemaType", - "x-ms-enum": { - "name": "SchemaType", - "modelAsString": true, - "values": [ - { - "value": "xml", - "description": "XML schema type.", - "name": "Xml" - }, - { - "value": "json", - "description": "Json schema type.", - "name": "Json" - } - ] - } - }, - "description": { - "type": "string", - "description": "Free-form schema entity description." - }, - "value": { - "description": "Json-encoded string for non json-based schema." - }, - "document": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/GlobalSchemaDocumentProperties", - "description": "Global Schema document object for json-based schema formats(e.g. json schema)." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "The provisioning state" - } - }, - "required": [ - "schemaType" - ], - "description": "Schema create or update contract Properties." - }, - "GlobalSchemaDocumentProperties": { - "type": "object", - "description": "Global Schema Document Properties." - }, - "SubscriptionCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SubscriptionContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Subscriptions list representation." - }, - "SubscriptionContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SubscriptionContractProperties", - "description": "Subscription contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Subscription details." - }, - "SubscriptionContractProperties": { - "type": "object", - "properties": { - "ownerId": { - "type": "string", - "description": "The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier." - }, - "scope": { - "type": "string", - "description": "Scope like /products/{productId} or /apis or /apis/{apiId}." - }, - "displayName": { - "type": "string", - "description": "The name of the subscription, or null if the subscription has no name.", - "minLength": 0, - "maxLength": 100 - }, - "state": { - "type": "string", - "description": "Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.", - "enum": [ - "suspended", - "active", - "expired", - "submitted", - "rejected", - "cancelled" - ], - "x-ms-enum": { - "name": "SubscriptionState", - "modelAsString": false - } - }, - "createdDate": { - "type": "string", - "format": "date-time", - "description": "Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n", - "readOnly": true - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "endDate": { - "type": "string", - "format": "date-time", - "description": "Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "notificationDate": { - "type": "string", - "format": "date-time", - "description": "Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "primaryKey": { - "x-ms-secret": true, - "type": "string", - "description": "Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", - "minLength": 1, - "maxLength": 256 - }, - "secondaryKey": { - "x-ms-secret": true, - "type": "string", - "description": "Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", - "minLength": 1, - "maxLength": 256 - }, - "stateComment": { - "type": "string", - "description": "Optional subscription comment added by an administrator when the state is changed to the 'rejected'." - }, - "allowTracing": { - "type": "boolean", - "description": "Determines whether tracing is enabled", - "x-apim-code-nillable": true - } - }, - "required": [ - "scope", - "state" - ], - "description": "Subscription details." - }, - "SubscriptionCreateParameterProperties": { - "type": "object", - "properties": { - "ownerId": { - "type": "string", - "description": "User (user id path) for whom subscription is being created in form /users/{userId}" - }, - "scope": { - "type": "string", - "description": "Scope like /products/{productId} or /apis or /apis/{apiId}." - }, - "displayName": { - "type": "string", - "description": "Subscription name.", - "minLength": 1, - "maxLength": 100 - }, - "primaryKey": { - "type": "string", - "description": "Primary subscription key. If not specified during request key will be generated automatically.", - "minLength": 1, - "maxLength": 256 - }, - "secondaryKey": { - "type": "string", - "description": "Secondary subscription key. If not specified during request key will be generated automatically.", - "minLength": 1, - "maxLength": 256 - }, - "state": { - "type": "string", - "description": "Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.", - "enum": [ - "suspended", - "active", - "expired", - "submitted", - "rejected", - "cancelled" - ], - "x-ms-enum": { - "name": "SubscriptionState", - "modelAsString": false - } - }, - "allowTracing": { - "type": "boolean", - "description": "Determines whether tracing can be enabled" - } - }, - "required": [ - "scope", - "displayName" - ], - "description": "Parameters supplied to the Create subscription operation." - }, - "SubscriptionCreateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SubscriptionCreateParameterProperties", - "description": "Subscription contract properties." - } - }, - "description": "Subscription create details." - }, - "SubscriptionKeyParameterNamesContract": { - "type": "object", - "properties": { - "header": { - "type": "string", - "description": "Subscription key header name." - }, - "query": { - "type": "string", - "description": "Subscription key query string parameter name." - } - }, - "description": "Subscription key parameter names details.", - "example": { - "subscriptionKeyParameterNames": { - "query": "customQueryParameterName", - "header": "customHeaderParameterName" - } - } - }, - "SubscriptionsDelegationSettingsProperties": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable or disable delegation for subscriptions." - } - }, - "description": "Subscriptions delegation settings properties." - }, - "SubscriptionUpdateParameterProperties": { - "type": "object", - "properties": { - "ownerId": { - "type": "string", - "description": "User identifier path: /users/{userId}" - }, - "scope": { - "type": "string", - "description": "Scope like /products/{productId} or /apis or /apis/{apiId}" - }, - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." - }, - "displayName": { - "type": "string", - "description": "Subscription name." - }, - "primaryKey": { - "type": "string", - "description": "Primary subscription key.", - "minLength": 1, - "maxLength": 256 - }, - "secondaryKey": { - "type": "string", - "description": "Secondary subscription key.", - "minLength": 1, - "maxLength": 256 - }, - "state": { - "type": "string", - "description": "Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.", - "enum": [ - "suspended", - "active", - "expired", - "submitted", - "rejected", - "cancelled" - ], - "x-ms-enum": { - "name": "SubscriptionState", - "modelAsString": false - } - }, - "stateComment": { - "type": "string", - "description": "Comments describing subscription state change by the administrator when the state is changed to the 'rejected'." - }, - "allowTracing": { - "type": "boolean", - "description": "Determines whether tracing can be enabled" - } - }, - "description": "Parameters supplied to the Update subscription operation." - }, - "SubscriptionUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SubscriptionUpdateParameterProperties", - "description": "Subscription Update contract properties." - } - }, - "description": "Subscription update details." - }, - "TagCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TagContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Tag list representation." - }, - "TagContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/TagContractProperties", - "description": "Tag entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Tag Contract details." - }, - "TagContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Tag name.", - "maxLength": 160, - "minLength": 1 - } - }, - "required": [ - "displayName" - ], - "description": "Tag contract Properties." - }, - "TagCreateUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/TagContractProperties", - "description": "Properties supplied to Create Tag operation." - } - }, - "description": "Parameters supplied to Create/Update Tag operations." - }, - "TagDescriptionBaseProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the Tag." - }, - "externalDocsUrl": { - "type": "string", - "description": "Absolute URL of external resources describing the tag.", - "maxLength": 2000 - }, - "externalDocsDescription": { - "type": "string", - "description": "Description of the external resources describing the tag." - } - }, - "description": "Parameters supplied to the Create TagDescription operation." - }, - "TagDescriptionCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TagDescriptionContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged TagDescription list representation." - }, - "TagDescriptionContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/TagDescriptionContractProperties", - "description": "TagDescription entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Contract details." - }, - "TagDescriptionContractProperties": { - "type": "object", - "properties": { - "tagId": { - "type": "string", - "description": "Identifier of the tag in the form of /tags/{tagId}" - }, - "displayName": { - "type": "string", - "description": "Tag name.", - "maxLength": 160, - "minLength": 1 - } - }, - "allOf": [ - { - "$ref": "#/definitions/TagDescriptionBaseProperties" - } - ], - "description": "TagDescription contract Properties." - }, - "TagDescriptionCreateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/TagDescriptionBaseProperties", - "description": "Properties supplied to Create TagDescription operation." - } - }, - "description": "Parameters supplied to the Create TagDescription operation." - }, - "TagResourceCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TagResourceContract" - }, - "x-ms-identifiers": [ - "tag/id" - ], - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Tag list representation." - }, - "TagResourceContract": { - "type": "object", - "properties": { - "tag": { - "$ref": "#/definitions/TagTagResourceContractProperties", - "description": "Tag associated with the resource." - }, - "api": { - "$ref": "#/definitions/ApiTagResourceContractProperties", - "description": "API associated with the tag." - }, - "operation": { - "$ref": "#/definitions/OperationTagResourceContractProperties", - "description": "Operation associated with the tag." - }, - "product": { - "$ref": "#/definitions/ProductTagResourceContractProperties", - "description": "Product associated with the tag." - } - }, - "required": [ - "tag" - ], - "description": "TagResource contract properties." - }, - "TagTagResourceContractProperties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Tag identifier" - }, - "name": { - "type": "string", - "description": "Tag Name", - "minLength": 1, - "maxLength": 160 - } - }, - "description": "Contract defining the Tag property in the Tag Resource Contract" - }, - "TenantConfigurationSyncStateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/TenantConfigurationSyncStateContractProperties", - "description": "Properties returned Tenant Configuration Sync State check." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Result of Tenant Configuration Sync State." - }, - "TenantConfigurationSyncStateContractProperties": { - "type": "object", - "properties": { - "branch": { - "type": "string", - "description": "The name of Git branch." - }, - "commitId": { - "type": "string", - "description": "The latest commit Id." - }, - "isExport": { - "type": "boolean", - "description": "value indicating if last sync was save (true) or deploy (false) operation." - }, - "isSynced": { - "type": "boolean", - "description": "value indicating if last synchronization was later than the configuration change." - }, - "isGitEnabled": { - "type": "boolean", - "description": "value indicating whether Git configuration access is enabled." - }, - "syncDate": { - "type": "string", - "format": "date-time", - "description": "The date of the latest synchronization. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "configurationChangeDate": { - "type": "string", - "format": "date-time", - "description": "The date of the latest configuration change. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "lastOperationId": { - "type": "string", - "description": "Most recent tenant configuration operation identifier" - } - }, - "description": "Tenant Configuration Synchronization State." - }, - "TermsOfServiceProperties": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "A terms of service text." - }, - "enabled": { - "type": "boolean", - "description": "Display terms of service during a sign-up process." - }, - "consentRequired": { - "type": "boolean", - "description": "Ask user for consent to the terms of service." - } - }, - "description": "Terms of service contract properties." - }, - "TokenBodyParameterContract": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "body parameter name." - }, - "value": { - "type": "string", - "description": "body parameter value." - } - }, - "required": [ - "name", - "value" - ], - "description": "OAuth acquire token request body parameter (www-url-form-encoded)." - }, - "UserCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/UserContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Users list representation." - }, - "UserContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/UserContractProperties", - "description": "User entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "User details." - }, - "UserContractProperties": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "description": "First name." - }, - "lastName": { - "type": "string", - "description": "Last name." - }, - "email": { - "type": "string", - "description": "Email address." - }, - "registrationDate": { - "type": "string", - "format": "date-time", - "description": "Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - }, - "groups": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "./definitions.json#/definitions/GroupContractProperties" - }, - "x-ms-identifiers": [ - "displayName" - ], - "description": "Collection of groups user is part of." - } - }, - "allOf": [ - { - "$ref": "#/definitions/UserEntityBaseParameters" - } - ], - "description": "User profile." - }, - "UserCreateParameterProperties": { - "type": "object", - "properties": { - "email": { - "type": "string", - "description": "Email address. Must not be empty and must be unique within the service instance.", - "minLength": 1, - "maxLength": 254 - }, - "firstName": { - "type": "string", - "description": "First name.", - "minLength": 1, - "maxLength": 100 - }, - "lastName": { - "type": "string", - "description": "Last name.", - "minLength": 1, - "maxLength": 100 - }, - "password": { - "type": "string", - "description": "User Password. If no value is provided, a default password is generated." - }, - "appType": { - "type": "string", - "description": "Determines the type of application which send the create user request. Default is legacy portal.", - "enum": [ - "portal", - "developerPortal" - ], - "x-ms-enum": { - "name": "AppType", - "modelAsString": true, - "values": [ - { - "value": "portal", - "description": "User create request was sent by legacy developer portal." - }, - { - "value": "developerPortal", - "description": "User create request was sent by new developer portal." - } - ] - } - }, - "confirmation": { - "type": "string", - "description": "Determines the type of confirmation e-mail that will be sent to the newly created user.", - "enum": [ - "signup", - "invite" - ], - "x-ms-enum": { - "name": "Confirmation", - "modelAsString": true, - "values": [ - { - "value": "signup", - "description": "Send an e-mail to the user confirming they have successfully signed up." - }, - { - "value": "invite", - "description": "Send an e-mail inviting the user to sign-up and complete registration." - } - ] - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/UserEntityBaseParameters" - } - ], - "required": [ - "email", - "firstName", - "lastName" - ], - "description": "Parameters supplied to the Create User operation." - }, - "UserCreateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/UserCreateParameterProperties", - "description": "User entity create contract properties." - } - }, - "description": "User create details." - }, - "UserEntityBaseParameters": { - "type": "object", - "properties": { - "state": { - "type": "string", - "description": "Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.", - "enum": [ - "active", - "blocked", - "pending", - "deleted" - ], - "default": "active", - "x-ms-enum": { - "name": "UserState", - "modelAsString": true, - "values": [ - { - "value": "active", - "description": "User state is active." - }, - { - "value": "blocked", - "description": "User is blocked. Blocked users cannot authenticate at developer portal or call API." - }, - { - "value": "pending", - "description": "User account is pending. Requires identity confirmation before it can be made active." - }, - { - "value": "deleted", - "description": "User account is closed. All identities and related entities are removed." - } - ] - } - }, - "note": { - "type": "string", - "description": "Optional note about a user set by the administrator." - }, - "identities": { - "type": "array", - "items": { - "$ref": "#/definitions/UserIdentityContract" - }, - "description": "Collection of user identities." - } - }, - "description": "User Entity Base Parameters set." - }, - "UserIdentityCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/UserIdentityContract" - }, - "description": "User Identity values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "List of Users Identity list representation." - }, - "UserIdentityContract": { - "type": "object", - "properties": { - "provider": { - "type": "string", - "description": "Identity provider name." - }, - "id": { - "type": "string", - "description": "Identifier value within provider." - } - }, - "description": "User identity details." - }, - "UserTokenParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/UserTokenParameterProperties", - "description": "User Token Parameter contract properties." - } - }, - "description": "Get User Token parameters." - }, - "UserTokenParameterProperties": { - "type": "object", - "properties": { - "keyType": { - "type": "string", - "description": "The Key to be used to generate token for user.", - "enum": [ - "primary", - "secondary" - ], - "default": "primary", - "x-ms-enum": { - "name": "KeyType", - "modelAsString": false - } - }, - "expiry": { - "type": "string", - "format": "date-time", - "description": "The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - } - }, - "required": [ - "keyType", - "expiry" - ], - "description": "Parameters supplied to the Get User Token operation." - }, - "UserTokenResult": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "Shared Access Authorization token for the User." - } - }, - "description": "Get User Token response details." - }, - "UserUpdateParameters": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/UserUpdateParametersProperties", - "description": "User entity update contract properties." - } - }, - "description": "User update parameters." - }, - "UserUpdateParametersProperties": { - "type": "object", - "properties": { - "email": { - "type": "string", - "description": "Email address. Must not be empty and must be unique within the service instance.", - "minLength": 1, - "maxLength": 254 - }, - "password": { - "type": "string", - "description": "User Password." - }, - "firstName": { - "type": "string", - "description": "First name.", - "minLength": 1, - "maxLength": 100 - }, - "lastName": { - "type": "string", - "description": "Last name.", - "minLength": 1, - "maxLength": 100 - } - }, - "allOf": [ - { - "$ref": "#/definitions/UserEntityBaseParameters" - } - ], - "description": "Parameters supplied to the Update User operation." - }, - "X509CertificateName": { - "type": "object", - "properties": { - "name": { - "description": "Common Name of the Certificate.", - "type": "string" - }, - "issuerCertificateThumbprint": { - "description": "Thumbprint for the Issuer of the Certificate.", - "type": "string" - } - }, - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-windows-cluster-x509-security" - }, - "description": "Properties of server X509Names." - }, - "ClientSecretContract": { - "type": "object", - "properties": { - "clientSecret": { - "type": "string", - "x-ms-secret": true, - "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth." - } - }, - "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth." - }, - "NamedValueSecretContract": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "This is secret value of the NamedValue entity." - } - }, - "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth." - }, - "PortalSettingValidationKeyContract": { - "type": "object", - "properties": { - "validationKey": { - "type": "string", - "x-ms-secret": true, - "description": "This is secret value of the validation key in portal settings." - } - }, - "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth." - }, - "SubscriptionKeysContract": { - "type": "object", - "properties": { - "primaryKey": { - "type": "string", - "description": "Subscription primary key.", - "minLength": 1, - "maxLength": 256 - }, - "secondaryKey": { - "type": "string", - "description": "Subscription secondary key.", - "minLength": 1, - "maxLength": 256 - } - }, - "description": "Subscription keys." - }, - "GatewayCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/GatewayContract" - }, - "description": "Page values.", - "readOnly": true - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Gateway list representation." - }, - "GatewayContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/GatewayContractProperties", - "description": "Gateway details." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Gateway details." - }, - "GatewayContractProperties": { - "type": "object", - "properties": { - "locationData": { - "$ref": "#/definitions/ResourceLocationDataContract", - "description": "Gateway location." - }, - "description": { - "type": "string", - "description": "Gateway description", - "maxLength": 1000 - } - }, - "description": "Properties of the Gateway contract." - }, - "WorkspaceLinksBaseProperties": { - "type": "object", - "properties": { - "workspaceId": { - "type": "string", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ApiManagement/service/workspaces" - } - ] - }, - "description": "The link to the API Management service workspace." - }, - "gateways": { - "type": "array", - "items": { - "$ref": "#/definitions/WorkspaceLinksGateway" - }, - "description": "The array of linked gateways." - } - } - }, - "WorkspaceLinksGateway": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ApiManagement/gateways" - } - ] - }, - "description": "The link to the API Management gateway." - } - } - }, - "ApiManagementWorkspaceLinksProperties": { - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "#/definitions/WorkspaceLinksBaseProperties" - } - ], - "description": "Properties of an API Management workspaceLinks resource." - }, - "ApiManagementWorkspaceLinksResource": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiManagementWorkspaceLinksProperties", - "description": "Properties of the API Management WorkspaceLinks." - }, - "etag": { - "type": "string", - "description": "ETag of the resource.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "required": [ - "properties" - ], - "description": "A single API Management WorkspaceLinks in List or Get response." - }, - "ApiManagementWorkspaceLinksListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiManagementWorkspaceLinksResource" - }, - "description": "Result of the List API Management WorkspaceLinks operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." - } - }, - "required": [ - "value" - ], - "description": "The response of the List API Management WorkspaceLink operation." - }, - "ResourceLocationDataContract": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "A canonical name for the geographic or physical location.", - "maxLength": 256 - }, - "city": { - "type": "string", - "description": "The city or locality where the resource is located.", - "maxLength": 256 - }, - "district": { - "type": "string", - "description": "The district, state, or province where the resource is located.", - "maxLength": 256 - }, - "countryOrRegion": { - "type": "string", - "description": "The country or region where the resource is located.", - "maxLength": 256 - } - }, - "required": [ - "name" - ], - "description": "Resource location data properties." - }, - "GatewayKeysContract": { - "type": "object", - "properties": { - "primary": { - "type": "string", - "description": "Primary gateway key." - }, - "secondary": { - "type": "string", - "description": "Secondary gateway key." - } - }, - "description": "Gateway authentication keys." - }, - "GatewayTokenRequestContract": { - "type": "object", - "properties": { - "keyType": { - "type": "string", - "description": "The Key to be used to generate gateway token.", - "enum": [ - "primary", - "secondary" - ], - "default": "primary", - "x-ms-enum": { - "name": "KeyType", - "modelAsString": false - } - }, - "expiry": { - "type": "string", - "format": "date-time", - "description": "The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" - } - }, - "required": [ - "keyType", - "expiry" - ], - "description": "Gateway token request contract properties." - }, - "GatewayTokenContract": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "Shared Access Authentication token value for the Gateway." - } - }, - "description": "Gateway access token." - }, - "GatewayKeyRegenerationRequestContract": { - "type": "object", - "properties": { - "keyType": { - "type": "string", - "description": "The Key being regenerated.", - "enum": [ - "primary", - "secondary" - ], - "x-ms-enum": { - "name": "KeyType", - "modelAsString": false - } - } - }, - "required": [ - "keyType" - ], - "description": "Gateway key regeneration request contract properties." - }, - "GatewayHostnameConfigurationCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/GatewayHostnameConfigurationContract" - }, - "description": "Page values.", - "readOnly": true - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Gateway hostname configuration list representation." - }, - "GatewayHostnameConfigurationContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/GatewayHostnameConfigurationContractProperties", - "description": "Gateway hostname configuration details." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Gateway hostname configuration details." - }, - "GatewayHostnameConfigurationContractProperties": { - "type": "object", - "properties": { - "hostname": { - "type": "string", - "description": "Hostname value. Supports valid domain name, partial or full wildcard" - }, - "certificateId": { - "type": "string", - "description": "Identifier of Certificate entity that will be used for TLS connection establishment" - }, - "negotiateClientCertificate": { - "type": "boolean", - "description": "Determines whether gateway requests client certificate" - }, - "tls10Enabled": { - "type": "boolean", - "description": "Specifies if TLS 1.0 is supported" - }, - "tls11Enabled": { - "type": "boolean", - "description": "Specifies if TLS 1.1 is supported" - }, - "http2Enabled": { - "type": "boolean", - "description": "Specifies if HTTP/2.0 is supported" - } - }, - "description": "Gateway hostname configuration details." - }, - "GatewayCertificateAuthorityCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/GatewayCertificateAuthorityContract" - }, - "description": "Page values.", - "readOnly": true - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged Gateway certificate authority list representation." - }, - "GatewayCertificateAuthorityContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/GatewayCertificateAuthorityContractProperties", - "description": "Gateway certificate authority details." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Gateway certificate authority details." - }, - "GatewayCertificateAuthorityContractProperties": { - "type": "object", - "properties": { - "isTrusted": { - "type": "boolean", - "description": "Determines whether certificate authority is trusted." - } - }, - "description": "Gateway certificate authority details." - }, - "AssociationContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "provisioningState": { - "type": "string", - "description": "Provisioning state.", - "enum": [ - "created" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } - } - }, - "description": "Association entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Association entity details." - }, - "ContentTypeCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ContentTypeContract" - }, - "description": "Collection of content types.", - "readOnly": true - }, - "nextLink": { - "type": "string", - "description": "Next page link, if any.", - "readOnly": true - } - }, - "description": "Paged list of content types." - }, - "ContentTypeContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ContentTypeContractProperties", - "description": "Properties of the content type." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Content type contract details." - }, - "ContentTypeContractProperties": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Content type identifier" - }, - "name": { - "type": "string", - "description": "Content type name. Must be 1 to 250 characters long." - }, - "description": { - "type": "string", - "description": "Content type description." - }, - "schema": { - "type": "object", - "description": "Content type schema." - }, - "version": { - "type": "string", - "description": "Content type version." - } - } - }, - "ContentItemCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ContentItemContract" - }, - "description": "Collection of content items.", - "readOnly": true - }, - "nextLink": { - "type": "string", - "description": "Next page link, if any.", - "readOnly": true - } - }, - "description": "Paged list of content items." - }, - "ContentItemContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ContentItemContractProperties", - "description": "Properties of the content item." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Content type contract details." - }, - "ContentItemContractProperties": { - "properties": {}, - "additionalProperties": true - }, - "DeletedServicesCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DeletedServiceContract" - }, - "description": "Page values.", - "readOnly": true - }, - "nextLink": { - "type": "string", - "description": "Next page link if any.", - "readOnly": true - } - }, - "description": "Paged deleted API Management Services List Representation." - }, - "DeletedServiceContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DeletedServiceContractProperties", - "description": "Deleted API Management Service details." - }, - "location": { - "readOnly": true, - "type": "string", - "description": "API Management Service Master Location." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Deleted API Management Service information." - }, - "DeletedServiceContractProperties": { - "type": "object", - "properties": { - "serviceId": { - "type": "string", - "description": "Fully-qualified API Management Service Resource ID" - }, - "scheduledPurgeDate": { - "type": "string", - "format": "date-time", - "description": "UTC Date and Time when the service will be automatically purged. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." - }, - "deletionDate": { - "type": "string", - "format": "date-time", - "description": "UTC Timestamp when the service was soft-deleted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." - } - } - }, - "PortalRevisionCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PortalRevisionContract" - }, - "description": "Collection of portal revisions.", - "readOnly": true - }, - "nextLink": { - "type": "string", - "description": "Next page link, if any.", - "readOnly": true - } - }, - "description": "Paged list of portal revisions." - }, - "PortalRevisionContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PortalRevisionContractProperties", - "description": "Properties of the portal revisions." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Portal Revision's contract details." - }, - "PortalRevisionContractProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Portal revision description.", - "maxLength": 2000 - }, - "statusDetails": { - "type": "string", - "description": "Portal revision publishing status details.", - "maxLength": 2000, - "readOnly": true - }, - "status": { - "type": "string", - "description": "Status of the portal's revision.", - "enum": [ - "pending", - "publishing", - "completed", - "failed" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "portalRevisionStatus", - "values": [ - { - "value": "pending", - "description": "Portal's revision has been queued." - }, - { - "value": "publishing", - "description": "Portal's revision is being published." - }, - { - "value": "completed", - "description": "Portal's revision publishing completed." - }, - { - "value": "failed", - "description": "Portal's revision publishing failed." - } - ] - }, - "readOnly": true - }, - "isCurrent": { - "type": "boolean", - "description": "Indicates if the portal's revision is public." - }, - "createdDateTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "Portal's revision creation date and time." - }, - "updatedDateTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "Last updated date and time." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "The provisioning state" - } - } - }, - "PrivateEndpointConnectionRequest": { - "description": "A request to approve or reject a private endpoint connection", - "type": "object", - "properties": { - "id": { - "description": "Private Endpoint Connection Resource Id.", - "type": "string" - }, - "properties": { - "type": "object", - "description": "The connection state of the private endpoint connection.", - "properties": { - "privateLinkServiceConnectionState": { - "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", - "description": "A collection of information about the state of the connection between service consumer and provider." - } - } - } - } - }, - "RemotePrivateEndpointConnectionWrapper": { - "description": "Remote Private Endpoint Connection resource.", - "type": "object", - "properties": { - "id": { - "description": "Private Endpoint connection resource id", - "type": "string" - }, - "name": { - "description": "Private Endpoint Connection Name", - "type": "string" - }, - "type": { - "description": "Private Endpoint Connection Resource Type", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/PrivateEndpointConnectionWrapperProperties", - "x-ms-client-flatten": true, - "description": "Resource properties." - } - } - }, - "PrivateEndpointConnectionWrapperProperties": { - "properties": { - "privateEndpoint": { - "$ref": "#/definitions/ArmIdWrapper", - "description": "The resource of private end point." - }, - "privateLinkServiceConnectionState": { - "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", - "description": "A collection of information about the state of the connection between service consumer and provider." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "The provisioning state of the private endpoint connection resource." - }, - "groupIds": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "All the Group ids." - } - }, - "required": [ - "privateLinkServiceConnectionState" - ], - "description": "Properties of the PrivateEndpointConnectProperties.", - "type": "object" - }, - "ArmIdWrapper": { - "description": "A wrapper for an ARM resource id", - "type": "object", - "properties": { - "id": { - "type": "string", - "readOnly": true - } - } - }, - "ConnectivityCheckRequest": { - "description": "A request to perform the connectivity check operation on a API Management service.", - "type": "object", - "required": [ - "source", - "destination" - ], - "properties": { - "source": { - "description": "Definitions about the connectivity check origin.", - "type": "object", - "required": [ - "region" - ], - "properties": { - "region": { - "description": "The API Management service region from where to start the connectivity check operation.", - "type": "string", - "example": "westus" - }, - "instance": { - "description": "The particular VMSS instance from which to fire the request.", - "type": "integer", - "format": "int64" - } - } - }, - "destination": { - "description": "The connectivity check operation destination.", - "type": "object", - "required": [ - "address", - "port" - ], - "properties": { - "address": { - "description": "Destination address. Can either be an IP address or a FQDN.", - "type": "string", - "example": "microsoft.com" - }, - "port": { - "description": "Destination port.", - "type": "integer", - "format": "int64", - "example": 80 - } - } - }, - "preferredIPVersion": { - "description": "The IP version to be used. Only IPv4 is supported for now.", - "type": "string", - "enum": [ - "IPv4" - ], - "x-ms-enum": { - "name": "PreferredIPVersion", - "modelAsString": true - } - }, - "protocol": { - "description": "The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value.", - "type": "string", - "enum": [ - "TCP", - "HTTP", - "HTTPS" - ], - "x-ms-enum": { - "name": "ConnectivityCheckProtocol", - "modelAsString": true - } - }, - "protocolConfiguration": { - "description": "Protocol-specific configuration.", - "type": "object", - "properties": { - "HTTPConfiguration": { - "description": "Configuration for HTTP or HTTPS requests.", - "type": "object", - "properties": { - "method": { - "description": "The HTTP method to be used.", - "type": "string", - "enum": [ - "GET", - "POST" - ], - "x-ms-enum": { - "name": "Method", - "modelAsString": true - } - }, - "validStatusCodes": { - "type": "array", - "description": "List of HTTP status codes considered valid for the request response.", - "items": { - "type": "integer", - "format": "int64" - } - }, - "headers": { - "type": "array", - "description": "List of headers to be included in the request.", - "items": { - "$ref": "#/definitions/HTTPHeader" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - } - } - } - } - }, - "HTTPHeader": { - "description": "HTTP header and it's value.", - "type": "object", - "required": [ - "name", - "value" - ], - "properties": { - "name": { - "type": "string", - "description": "Header name." - }, - "value": { - "type": "string", - "description": "Header value." - } - } - }, - "ConnectivityCheckResponse": { - "description": "Information on the connectivity status.", - "type": "object", - "properties": { - "hops": { - "readOnly": true, - "type": "array", - "description": "List of hops between the source and the destination.", - "items": { - "$ref": "#/definitions/ConnectivityHop" - } - }, - "connectionStatus": { - "readOnly": true, - "type": "string", - "enum": [ - "Unknown", - "Connected", - "Disconnected", - "Degraded" - ], - "x-ms-enum": { - "name": "ConnectionStatus", - "modelAsString": true - }, - "description": "The connection status." - }, - "avgLatencyInMs": { - "description": "Average latency in milliseconds.", - "readOnly": true, - "type": "integer", - "format": "int64" - }, - "minLatencyInMs": { - "description": "Minimum latency in milliseconds.", - "readOnly": true, - "type": "integer", - "format": "int64" - }, - "maxLatencyInMs": { - "description": "Maximum latency in milliseconds.", - "readOnly": true, - "type": "integer", - "format": "int64" - }, - "probesSent": { - "description": "Total number of probes sent.", - "readOnly": true, - "type": "integer", - "format": "int64" - }, - "probesFailed": { - "description": "Number of failed probes.", - "readOnly": true, - "type": "integer", - "format": "int64" - } - } - }, - "ConnectivityHop": { - "description": "Information about a hop between the source and the destination.", - "type": "object", - "properties": { - "type": { - "description": "The type of the hop.", - "readOnly": true, - "type": "string" - }, - "id": { - "description": "The ID of the hop.", - "readOnly": true, - "type": "string" - }, - "address": { - "description": "The IP address of the hop.", - "readOnly": true, - "type": "string" - }, - "resourceId": { - "description": "The ID of the resource corresponding to this hop.", - "readOnly": true, - "type": "string" - }, - "nextHopIds": { - "readOnly": true, - "type": "array", - "description": "List of next hop identifiers.", - "items": { - "type": "string" - } - }, - "issues": { - "readOnly": true, - "type": "array", - "description": "List of issues.", - "items": { - "$ref": "#/definitions/ConnectivityIssue" - }, - "x-ms-identifiers": [] - } - } - }, - "ConnectivityIssue": { - "description": "Information about an issue encountered in the process of checking for connectivity.", - "type": "object", - "properties": { - "origin": { - "readOnly": true, - "type": "string", - "enum": [ - "Local", - "Inbound", - "Outbound" - ], - "x-ms-enum": { - "name": "Origin", - "modelAsString": true - }, - "description": "The origin of the issue." - }, - "severity": { - "readOnly": true, - "type": "string", - "enum": [ - "Error", - "Warning" - ], - "x-ms-enum": { - "name": "Severity", - "modelAsString": true - }, - "description": "The severity of the issue." - }, - "type": { - "readOnly": true, - "type": "string", - "enum": [ - "Unknown", - "AgentStopped", - "GuestFirewall", - "DnsResolution", - "SocketBind", - "NetworkSecurityRule", - "UserDefinedRoute", - "PortThrottled", - "Platform" - ], - "x-ms-enum": { - "name": "IssueType", - "modelAsString": true - }, - "description": "The type of issue." - }, - "context": { - "readOnly": true, - "type": "array", - "description": "Provides additional context on the issue.", - "items": { - "$ref": "#/definitions/IssueContext" - }, - "x-ms-identifiers": [] - } - } - }, - "IssueContext": { - "description": "A key-value pair that provides additional context on the issue.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "DocumentationContractProperties": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "documentation title." - }, - "content": { - "type": "string", - "description": "Markdown documentation content." - } - }, - "description": "Markdown documentation details." - }, - "DocumentationContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DocumentationContractProperties", - "description": "Markdown Documentation details." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Markdown documentation details." - }, - "DocumentationUpdateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DocumentationContractProperties", - "description": "Markdown Documentation details." - } - }, - "description": "Documentation update contract details." - }, - "WikiDocumentationContract": { - "type": "object", - "properties": { - "documentationId": { - "type": "string", - "description": "Documentation Identifier" - } - }, - "description": "Wiki documentation details." - }, - "WikiContractProperties": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Collection wiki documents included into this wiki.", - "items": { - "$ref": "#/definitions/WikiDocumentationContract" - }, - "x-ms-identifiers": [ - "documentationId" - ] - } - }, - "description": "Wiki contract details" - }, - "WikiContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/WikiContractProperties", - "description": "Wiki details." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Wiki properties" - }, - "WikiUpdateContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/WikiContractProperties", - "description": "Wiki details." - } - }, - "description": "Wiki update contract details." - }, - "WorkspaceCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/WorkspaceContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged workspace list representation." - }, - "WorkspaceContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkspaceContractProperties", - "description": "Workspace entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Workspace details." - }, - "WorkspaceContractProperties": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Name of the workspace." - }, - "description": { - "type": "string", - "description": "Description of the workspace." - } - }, - "required": [ - "displayName" - ], - "description": "Workspace entity properties." - }, - "ProductApiLinkCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ProductApiLinkContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Product-API link list representation." - }, - "ProductApiLinkContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ProductApiLinkContractProperties", - "description": "Product-API link entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Product-API link details." - }, - "ProductApiLinkContractProperties": { - "type": "object", - "properties": { - "apiId": { - "type": "string", - "description": "Full resource Id of an API." - } - }, - "required": [ - "apiId" - ], - "description": "Product-API link entity properties." - }, - "ProductGroupLinkCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ProductGroupLinkContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Product-group link list representation." - }, - "ProductGroupLinkContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ProductGroupLinkContractProperties", - "description": "Product-group link entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Product-group link details." - }, - "ProductGroupLinkContractProperties": { - "type": "object", - "properties": { - "groupId": { - "type": "string", - "description": "Full resource Id of a group." - } - }, - "required": [ - "groupId" - ], - "description": "Product-group link entity properties." - }, - "TagApiLinkCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TagApiLinkContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Tag-API link list representation." - }, - "TagApiLinkContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/TagApiLinkContractProperties", - "description": "Tag-API link entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Tag-API link details." - }, - "TagApiLinkContractProperties": { - "type": "object", - "properties": { - "apiId": { - "type": "string", - "description": "Full resource Id of an API." - } - }, - "required": [ - "apiId" - ], - "description": "Tag-API link entity properties." - }, - "TagOperationLinkCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TagOperationLinkContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Tag-operation link list representation." - }, - "TagOperationLinkContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/TagOperationLinkContractProperties", - "description": "Tag-API link entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Tag-operation link details." - }, - "TagOperationLinkContractProperties": { - "type": "object", - "properties": { - "operationId": { - "type": "string", - "description": "Full resource Id of an API operation." - } - }, - "required": [ - "operationId" - ], - "description": "Tag-operation link entity properties." - }, - "TagProductLinkCollection": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TagProductLinkContract" - }, - "description": "Page values." - }, - "count": { - "type": "integer", - "format": "int64", - "description": "Total record count number across all pages." - }, - "nextLink": { - "type": "string", - "description": "Next page link if any." - } - }, - "description": "Paged Tag-product link list representation." - }, - "TagProductLinkContract": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/TagProductLinkContractProperties", - "description": "Tag-API link entity contract properties." - } - }, - "allOf": [ - { - "$ref": "./../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "description": "Tag-product link details." - }, - "TagProductLinkContractProperties": { - "type": "object", - "properties": { - "productId": { - "type": "string", - "description": "Full resource Id of a product." - } - }, - "required": [ - "productId" - ], - "description": "Tag-product link entity properties." - }, - "GatewayListDebugCredentialsContract": { - "type": "object", - "properties": { - "credentialsExpireAfter": { - "type": "string", - "format": "duration", - "description": "Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used." - }, - "purposes": { - "type": "array", - "description": "Purposes of debug credential.", - "items": { - "type": "string", - "description": "Purpose of debug credential.", - "enum": [ - "tracing" - ], - "x-ms-enum": { - "name": "GatewayListDebugCredentialsContractPurpose", - "modelAsString": true, - "values": [ - { - "value": "tracing", - "description": "The tracing purpose." - } - ] - } - } - }, - "apiId": { - "type": "string", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ApiManagement/service/apis" - }, - { - "type": "Microsoft.ApiManagement/service/workspaces/apis" - } - ] - }, - "description": "Full resource Id of an API." - } - }, - "required": [ - "purposes", - "apiId" - ], - "description": "List debug credentials properties." - }, - "GatewayDebugCredentialsContract": { - "type": "object", - "properties": { - "token": { - "type": "string", - "x-ms-secret": true, - "description": "Gateway debug token." - } - }, - "description": "Gateway debug credentials." - }, - "GatewayListTraceContract": { - "type": "object", - "properties": { - "traceId": { - "type": "string", - "description": "Trace id." - } - }, - "description": "List trace properties." - }, - "GatewayTraceContract": { - "type": "object", - "properties": {}, - "additionalProperties": true, - "description": "Trace collected in gateway." - } - }, - "parameters": {} -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementAllPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementAllPolicies.json index f5f212c318e7..047f5780d071 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementAllPolicies.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementAllPolicies.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/allpolicies/allpolicies1", - "type": "Microsoft.ApiManagement/service/allpolicies", "name": "allpolicies1", + "type": "Microsoft.ApiManagement/service/allpolicies", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/allpolicies/allpolicies1", "properties": { - "referencePolicyId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/policies/policy", - "complianceState": "Compliant" + "complianceState": "Compliant", + "referencePolicyId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/policies/policy" } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "AllPolicies_ListByService", + "title": "ApiManagementListPolicyRestrictions" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementApplyNetworkConfigurationUpdates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementApplyNetworkConfigurationUpdates.json index e46a1985d0cd..e69d708fad93 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementApplyNetworkConfigurationUpdates.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementApplyNetworkConfigurationUpdates.json @@ -1,43 +1,35 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { "location": "west us" - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "UID": "52ed5986-717b-45b4-b17c-3df8db372cff" - }, - "location": "East Asia", "etag": "AAAAAAAXX6Y=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "East Asia", "properties": { - "publisherEmail": "admin@live.com", - "publisherName": "Contoso", - "provisioningState": "Succeeded", - "targetProvisioningState": "", "createdAtUtc": "2015-09-22T01:50:34.7921566Z", "gatewayUrl": "https://apimService1.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", "hostnameConfigurations": [], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", "publicIPAddresses": [ "207.46.155.24" ], + "publisherEmail": "admin@live.com", + "publisherName": "Contoso", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", "virtualNetworkConfiguration": { "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/eastUsVirtualNetwork/subnets/apimSubnet" }, @@ -46,8 +38,18 @@ "sku": { "name": "Premium", "capacity": 1 + }, + "tags": { + "UID": "52ed5986-717b-45b4-b17c-3df8db372cff" } } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" + } } - } + }, + "operationId": "ApiManagementService_ApplyNetworkConfigurationUpdates", + "title": "ApiManagementApplyNetworkConfigurationUpdates" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementApproveOrRejectPrivateEndpointConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementApproveOrRejectPrivateEndpointConnection.json index 91ef9f10db3a..c064cb93ff3a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementApproveOrRejectPrivateEndpointConnection.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementApproveOrRejectPrivateEndpointConnection.json @@ -1,42 +1,44 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "privateEndpointConnectionName": "privateEndpointConnectionName", "privateEndpointConnectionRequest": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName", "properties": { "privateLinkServiceConnectionState": { - "status": "Approved", - "description": "The Private Endpoint Connection is approved." + "description": "The Private Endpoint Connection is approved.", + "status": "Approved" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" - } - }, "200": { "body": { "name": "privateEndpointConnectionName", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName", "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName", "properties": { - "provisioningState": "Succeeded", "privateEndpoint": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName" }, "privateLinkServiceConnectionState": { - "status": "Succeeded", - "description": "The request has been approved." - } + "description": "The request has been approved.", + "status": "Succeeded" + }, + "provisioningState": "Succeeded" } } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } } - } + }, + "operationId": "PrivateEndpointConnection_CreateOrUpdate", + "title": "ApiManagementApproveOrRejectPrivateEndpointConnection" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementAuthorizationServerListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementAuthorizationServerListSecrets.json index 605729be4c39..a31441b4f8ef 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementAuthorizationServerListSecrets.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementAuthorizationServerListSecrets.json @@ -1,18 +1,20 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "authsid": "newauthServer2" + "authsid": "newauthServer2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "clientSecret": "2", - "resourceOwnerUsername": "un", - "resourceOwnerPassword": "pwd" + "resourceOwnerPassword": "pwd", + "resourceOwnerUsername": "un" } } - } + }, + "operationId": "AuthorizationServer_ListSecrets", + "title": "ApiManagementAuthorizationServerListSecrets" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackendReconnect.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackendReconnect.json index b16a9b494897..1275159866c3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackendReconnect.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackendReconnect.json @@ -1,17 +1,19 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "backendId": "proxybackend", "parameters": { "properties": { "after": "PT3S" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "202": {} - } + }, + "operationId": "Backend_Reconnect", + "title": "ApiManagementBackendReconnect" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackupWithAccessKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackupWithAccessKey.json index caeb4f89c55b..56b5aae8f816 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackupWithAccessKey.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackupWithAccessKey.json @@ -1,138 +1,140 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { - "storageAccount": "teststorageaccount", - "containerName": "backupContainer", - "backupName": "apimService1backup_2017_03_19", + "accessKey": "**************************************************", "accessType": "AccessKey", - "accessKey": "**************************************************" - } + "backupName": "apimService1backup_2017_03_19", + "containerName": "backupContainer", + "storageAccount": "teststorageaccount" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" - }, - "location": "West US", "etag": "AAAAAAACXok=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "West US", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", + "additionalLocations": [ + { + "disableGateway": true, + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "location": "East US", + "publicIPAddresses": [ + "23.101.138.153" + ], + "sku": { + "name": "Premium", + "capacity": 1 + } + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, "createdAtUtc": "2019-12-18T06:26:20.3348609Z", - "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", + "defaultSslBinding": false, "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": false + "negotiateClientCertificate": false }, { "type": "Proxy", - "hostName": "gateway1.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" }, - "defaultSslBinding": true + "defaultSslBinding": true, + "hostName": "gateway1.msitesting.net", + "negotiateClientCertificate": false }, { "type": "Management", - "hostName": "mgmt.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" }, - "defaultSslBinding": false + "defaultSslBinding": false, + "hostName": "mgmt.msitesting.net", + "negotiateClientCertificate": false }, { "type": "Portal", - "hostName": "portal1.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" }, - "defaultSslBinding": false + "defaultSslBinding": false, + "hostName": "portal1.msitesting.net", + "negotiateClientCertificate": false }, { "type": "ConfigurationApi", - "hostName": "configuration-api.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" }, - "defaultSslBinding": false + "defaultSslBinding": false, + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false } ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", "publicIPAddresses": [ "13.91.32.113" ], - "additionalLocations": [ - { - "location": "East US", - "sku": { - "name": "Premium", - "capacity": 1 - }, - "publicIPAddresses": [ - "23.101.138.153" - ], - "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", - "disableGateway": true - } - ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, - "apiVersionConstraint": { - "minApiVersion": "2019-01-01" - } + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" } } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" + } } - } + }, + "operationId": "ApiManagementService_Backup", + "title": "ApiManagementBackupWithAccessKey" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackupWithSystemManagedIdentity.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackupWithSystemManagedIdentity.json index 2aa8f0546d6a..d6dcdbdb5540 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackupWithSystemManagedIdentity.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackupWithSystemManagedIdentity.json @@ -1,97 +1,99 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { - "storageAccount": "contosorpstorage", - "containerName": "apim-backups", + "accessType": "SystemAssignedManagedIdentity", "backupName": "backup5", - "accessType": "SystemAssignedManagedIdentity" - } + "containerName": "apim-backups", + "storageAccount": "contosorpstorage" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "Owner": "apimService1" + "etag": "AAAAAAAQM8o=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-5fb4-4916-95d4-64b306f9d924", + "tenantId": "00000000-86f1-0000-91ab-2d7cd011db47", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": { + "clientId": "00000000-a154-4830-0000-46a12da1a1e2", + "principalId": "00000000-a100-4478-0000-d65d98118ba0" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": { + "clientId": "00000000-6328-4db2-0000-ab0e3e7806cf", + "principalId": "00000000-9208-4128-af2d-a10d2af9b5a3" + } + } }, "location": "Central US EUAP", - "etag": "AAAAAAAQM8o=", "properties": { - "publisherEmail": "apimService1@corp.microsoft.com", - "publisherName": "MS", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", "createdAtUtc": "2020-04-23T16:26:47.8637967Z", - "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-centraluseuap-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-centraluseuap-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv1", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", "publicIPAddresses": [ "52.XXXX.160.66" ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, "publicNetworkAccess": "Enabled", - "platformVersion": "stv1" + "publisherEmail": "apimService1@corp.microsoft.com", + "publisherName": "MS", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 }, - "identity": { - "type": "SystemAssigned, UserAssigned", - "principalId": "00000000-5fb4-4916-95d4-64b306f9d924", - "tenantId": "00000000-86f1-0000-91ab-2d7cd011db47", - "userAssignedIdentities": { - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": { - "principalId": "00000000-a100-4478-0000-d65d98118ba0", - "clientId": "00000000-a154-4830-0000-46a12da1a1e2" - }, - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": { - "principalId": "00000000-9208-4128-af2d-a10d2af9b5a3", - "clientId": "00000000-6328-4db2-0000-ab0e3e7806cf" - } - } - }, "systemData": { + "lastModifiedAt": "2021-06-30T06:24:57.0008037Z", "lastModifiedBy": "contoso@microsoft.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-06-30T06:24:57.0008037Z" + "lastModifiedByType": "User" + }, + "tags": { + "Owner": "apimService1" } } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" + } } - } + }, + "operationId": "ApiManagementService_Backup", + "title": "ApiManagementBackupWithSystemManagedIdentity" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackupWithUserAssignedManagedIdentity.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackupWithUserAssignedManagedIdentity.json index f64f9d5b8d63..615220f75fcf 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackupWithUserAssignedManagedIdentity.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementBackupWithUserAssignedManagedIdentity.json @@ -1,98 +1,100 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { - "storageAccount": "contosorpstorage", - "containerName": "apim-backups", - "backupName": "backup5", "accessType": "UserAssignedManagedIdentity", - "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2" - } + "backupName": "backup5", + "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2", + "containerName": "apim-backups", + "storageAccount": "contosorpstorage" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "Owner": "apimService1" + "etag": "AAAAAAAQM8o=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-5fb4-4916-95d4-64b306f9d924", + "tenantId": "00000000-86f1-0000-91ab-2d7cd011db47", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": { + "clientId": "00000000-a154-4830-0000-46a12da1a1e2", + "principalId": "00000000-a100-4478-0000-d65d98118ba0" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": { + "clientId": "00000000-6328-4db2-0000-ab0e3e7806cf", + "principalId": "00000000-9208-4128-af2d-a10d2af9b5a3" + } + } }, "location": "Central US EUAP", - "etag": "AAAAAAAQM8o=", "properties": { - "publisherEmail": "apimService1@corp.microsoft.com", - "publisherName": "MS", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", "createdAtUtc": "2020-04-23T16:26:47.8637967Z", - "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-centraluseuap-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-centraluseuap-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv1", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", "publicIPAddresses": [ "52.XXXX.160.66" ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, "publicNetworkAccess": "Enabled", - "platformVersion": "stv1" + "publisherEmail": "apimService1@corp.microsoft.com", + "publisherName": "MS", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 }, - "identity": { - "type": "SystemAssigned, UserAssigned", - "principalId": "00000000-5fb4-4916-95d4-64b306f9d924", - "tenantId": "00000000-86f1-0000-91ab-2d7cd011db47", - "userAssignedIdentities": { - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": { - "principalId": "00000000-a100-4478-0000-d65d98118ba0", - "clientId": "00000000-a154-4830-0000-46a12da1a1e2" - }, - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": { - "principalId": "00000000-9208-4128-af2d-a10d2af9b5a3", - "clientId": "00000000-6328-4db2-0000-ab0e3e7806cf" - } - } - }, "systemData": { + "lastModifiedAt": "2021-06-30T06:24:57.0008037Z", "lastModifiedBy": "contoso@microsoft.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-06-30T06:24:57.0008037Z" + "lastModifiedByType": "User" + }, + "tags": { + "Owner": "apimService1" } } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" + } } - } + }, + "operationId": "ApiManagementService_Backup", + "title": "ApiManagementBackupWithUserAssignedManagedIdentity" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAILogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAILogger.json index e8ae454ae11f..7759f9cf87c2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAILogger.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAILogger.json @@ -1,51 +1,53 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "loggerId": "loggerId", "parameters": { "properties": { - "loggerType": "applicationInsights", "description": "adding a new logger", "credentials": { "instrumentationKey": "11................a1" - } + }, + "loggerType": "applicationInsights" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId", - "type": "Microsoft.ApiManagement/service/loggers", "name": "loggerId", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId", "properties": { - "loggerType": "applicationInsights", "description": null, "credentials": { "instrumentationKey": "{{5a.......2a}}" }, "isBuffered": false, - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.insights/components/airesource" + "loggerType": "applicationInsights" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId", - "type": "Microsoft.ApiManagement/service/loggers", "name": "loggerId", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId", "properties": { - "loggerType": "applicationInsights", "description": null, "credentials": { "instrumentationKey": "{{5a.......2a}}" }, - "isBuffered": false + "isBuffered": false, + "loggerType": "applicationInsights", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.insights/components/airesource" } } } - } + }, + "operationId": "Logger_CreateOrUpdate", + "title": "ApiManagementCreateAILogger" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApi.json index ff51ebe96bf2..5f5c6976b256 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApi.json @@ -1,12 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "tempgroup", "parameters": { "properties": { + "path": "newapiPath", "description": "apidescription5200", "authenticationSettings": { "oAuth2": { @@ -14,40 +12,32 @@ "scope": "oauth2scope2580" } }, - "subscriptionKeyParameterNames": { - "header": "header4520", - "query": "query3037" - }, "displayName": "apiname1463", - "serviceUrl": "http://newechoapi.cloudapp.net/api", - "path": "newapiPath", "protocols": [ "https", "http" - ] + ], + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/apis", "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "http://newechoapi.cloudapp.net/api", "path": "newapiPath", - "protocols": [ - "http", - "https" - ], + "description": "apidescription5200", + "apiRevision": "1", "authenticationSettings": { "oAuth2": { "authorizationServerId": "authorizationServerId2283", @@ -60,35 +50,35 @@ } ] }, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", "subscriptionKeyParameterNames": { "header": "header4520", "query": "query3037" - }, - "isCurrent": true, - "isOnline": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/apis", "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "http://newechoapi.cloudapp.net/api", "path": "newapiPath", - "protocols": [ - "http", - "https" - ], + "description": "apidescription5200", + "apiRevision": "1", "authenticationSettings": { "oAuth2": { "authorizationServerId": "authorizationServerId2283", @@ -101,15 +91,27 @@ } ] }, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", "subscriptionKeyParameterNames": { "header": "header4520", "query": "query3037" - }, - "isCurrent": true, - "isOnline": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiClone.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiClone.json index da01d88133f6..7c9999e439c9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiClone.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiClone.json @@ -1,84 +1,86 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "echo-api2", "parameters": { "properties": { - "displayName": "Echo API2", - "description": "Copy of Existing Echo Api including Operations.", - "subscriptionRequired": true, - "serviceUrl": "http://echoapi.cloudapp.net/api", "path": "echo2", + "description": "Copy of Existing Echo Api including Operations.", + "displayName": "Echo API2", + "isCurrent": true, "protocols": [ "http", "https" ], - "isCurrent": true, - "sourceApiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58a4aeac497000007d040001" + "serviceUrl": "http://echoapi.cloudapp.net/api", + "sourceApiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58a4aeac497000007d040001", + "subscriptionRequired": true } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapi2", - "type": "Microsoft.ApiManagement/service/apis", "name": "echoapi2", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapi2", "properties": { - "displayName": "Echo API2", - "apiRevision": "1", - "description": "Copy of Existing Echo Api including Operations.", - "subscriptionRequired": true, - "serviceUrl": "http://echoapi.cloudapp.net/api", "path": "echo2", + "description": "Copy of Existing Echo Api including Operations.", + "apiRevision": "1", + "displayName": "Echo API2", + "isCurrent": true, "protocols": [ "http", "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://echoapi.cloudapp.net/api", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" }, - "isCurrent": true, - "provisioningState": "InProgress" + "subscriptionRequired": true } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapi2", - "type": "Microsoft.ApiManagement/service/apis", "name": "echoapi2", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapi2", "properties": { - "displayName": "Echo API2", - "apiRevision": "1", - "description": "Copy of Existing Echo Api including Operations.", - "subscriptionRequired": true, - "serviceUrl": "http://echoapi.cloudapp.net/api", "path": "echo2", + "description": "Copy of Existing Echo Api including Operations.", + "apiRevision": "1", + "displayName": "Echo API2", + "isCurrent": true, "protocols": [ "http", "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://echoapi.cloudapp.net/api", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" }, - "isCurrent": true, - "provisioningState": "InProgress" + "subscriptionRequired": true } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiClone" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiDiagnostic.json index 13fd7150053d..660faddf8681 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiDiagnostic.json @@ -1,160 +1,162 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "diagnosticId": "applicationinsights", "apiId": "57d1f7558aa04f15146d9d8a", + "diagnosticId": "applicationinsights", "parameters": { "properties": { "alwaysLog": "allErrors", - "loggerId": "/loggers/applicationinsights", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/apis/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "loggerId": "/loggers/applicationinsights", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/apis/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "loggerId": "/loggers/applicationinsights", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } } } - } + }, + "operationId": "ApiDiagnostic_CreateOrUpdate", + "title": "ApiManagementCreateApiDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiIssue.json index 1f35e1e9e9a4..25ddfcec182d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiIssue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiIssue.json @@ -1,49 +1,51 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "issueId": "57d2ef278aa04f0ad01d6cdc", "apiId": "57d1f7558aa04f15146d9d8a", + "issueId": "57d2ef278aa04f0ad01d6cdc", "parameters": { "properties": { - "title": "New API issue", "description": "New API issue description", "createdDate": "2018-02-01T22:21:20.467Z", "state": "open", + "title": "New API issue", "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/apis/issues", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", "properties": { - "title": "New API issue", "description": "New API issue description", "createdDate": "2018-02-01T22:21:20.467Z", "state": "open", + "title": "New API issue", "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/apis/issues", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", "properties": { - "title": "New API issue", "description": "New API issue description", "createdDate": "2018-02-01T22:21:20.467Z", "state": "open", + "title": "New API issue", "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" } } } - } + }, + "operationId": "ApiIssue_CreateOrUpdate", + "title": "ApiManagementCreateApiIssue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiIssueAttachment.json index a472f94ad56e..a729cabb2eb0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiIssueAttachment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiIssueAttachment.json @@ -1,44 +1,46 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "issueId": "57d2ef278aa04f0ad01d6cdc", "apiId": "57d1f7558aa04f15146d9d8a", "attachmentId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", "parameters": { "properties": { - "title": "Issue attachment.", + "content": "IEJhc2U2NA==", "contentFormat": "image/jpeg", - "content": "IEJhc2U2NA==" + "title": "Issue attachment." } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", - "type": "Microsoft.ApiManagement/service/apis/issues/attachments", "name": "57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", "properties": { - "title": "Issue attachment.", + "content": "https://.../image.jpg", "contentFormat": "link", - "content": "https://.../image.jpg" + "title": "Issue attachment." } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", - "type": "Microsoft.ApiManagement/service/apis/issues/attachments", "name": "57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", "properties": { - "title": "Issue attachment.", + "content": "https://.../image.jpg", "contentFormat": "link", - "content": "https://.../image.jpg" + "title": "Issue attachment." } } } - } + }, + "operationId": "ApiIssueAttachment_CreateOrUpdate", + "title": "ApiManagementCreateApiIssueAttachment" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiIssueComment.json index 931fef17a72a..712fcd1e24ac 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiIssueComment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiIssueComment.json @@ -1,44 +1,46 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "issueId": "57d2ef278aa04f0ad01d6cdc", "apiId": "57d1f7558aa04f15146d9d8a", "commentId": "599e29ab193c3c0bd0b3e2fb", + "issueId": "57d2ef278aa04f0ad01d6cdc", "parameters": { "properties": { - "text": "Issue comment.", "createdDate": "2018-02-01T22:21:20.467Z", + "text": "Issue comment.", "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", - "type": "Microsoft.ApiManagement/service/apis/issues/comments", "name": "599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", "properties": { - "text": "Issue comment.", "createdDate": "2018-02-01T22:21:20.467Z", + "text": "Issue comment.", "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", - "type": "Microsoft.ApiManagement/service/apis/issues/comments", "name": "599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", "properties": { - "text": "Issue comment.", "createdDate": "2018-02-01T22:21:20.467Z", + "text": "Issue comment.", "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" } } } - } + }, + "operationId": "ApiIssueComment_CreateOrUpdate", + "title": "ApiManagementCreateApiIssueComment" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiNewVersionUsingExistingApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiNewVersionUsingExistingApi.json index 39b284681c0b..3141c987e6a2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiNewVersionUsingExistingApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiNewVersionUsingExistingApi.json @@ -1,100 +1,102 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "echoapiv3", "parameters": { "properties": { - "displayName": "Echo API2", - "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.", - "subscriptionRequired": true, - "serviceUrl": "http://echoapi.cloudapp.net/api", "path": "echo2", + "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.", + "apiVersion": "v4", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", + "displayName": "Echo API2", + "isCurrent": true, "protocols": [ "http", "https" ], - "isCurrent": true, - "apiVersion": "v4", + "serviceUrl": "http://echoapi.cloudapp.net/api", "sourceApiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoPath", - "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458" + "subscriptionRequired": true } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapiv3", - "type": "Microsoft.ApiManagement/service/apis", "name": "echoapiv3", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapiv3", "properties": { - "displayName": "Echo API2", - "apiRevision": "1", - "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.", - "subscriptionRequired": true, - "serviceUrl": "http://echoapi.cloudapp.net/api", "path": "echo2", + "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.", + "apiRevision": "1", + "apiVersion": "v4", + "apiVersionSet": { + "name": "Echo API2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", + "versioningScheme": "Segment" + }, + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", + "displayName": "Echo API2", + "isCurrent": true, "protocols": [ "http", "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://echoapi.cloudapp.net/api", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" }, - "isCurrent": true, - "apiVersion": "v4", - "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", - "apiVersionSet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", - "name": "Echo API2", - "versioningScheme": "Segment" - }, - "provisioningState": "InProgress" + "subscriptionRequired": true } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapiv3", - "type": "Microsoft.ApiManagement/service/apis", "name": "echoapiv3", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapiv3", "properties": { - "displayName": "Echo API2", - "apiRevision": "1", - "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.", - "subscriptionRequired": true, - "serviceUrl": "http://echoapi.cloudapp.net/api", "path": "echo2", + "description": "Create Echo API into a new Version using Existing Version Set and Copy all Operations.", + "apiRevision": "1", + "apiVersion": "v4", + "apiVersionSet": { + "name": "Echo API2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", + "versioningScheme": "Segment" + }, + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", + "displayName": "Echo API2", + "isCurrent": true, "protocols": [ "http", "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://echoapi.cloudapp.net/api", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" }, - "isCurrent": true, - "apiVersion": "v4", - "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", - "apiVersionSet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458", - "name": "Echo API2", - "versioningScheme": "Segment" - }, - "provisioningState": "InProgress" + "subscriptionRequired": true } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiNewVersionUsingExistingApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiOperation.json index 311bd77f225d..a3c20272f740 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiOperation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiOperation.json @@ -1,22 +1,19 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "newoperations", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "PetStoreTemplate2", - "operationId": "newoperations", "parameters": { "properties": { - "displayName": "createUser2", "method": "POST", - "urlTemplate": "/user1", - "templateParameters": [], "description": "This can only be done by the logged in user.", + "displayName": "createUser2", + "templateParameters": [], + "urlTemplate": "/user1", "request": { "description": "Created user object", - "queryParameters": [], "headers": [], + "queryParameters": [], "representations": [ { "contentType": "application/json", @@ -27,8 +24,8 @@ }, "responses": [ { - "statusCode": 200, "description": "successful operation", + "headers": [], "representations": [ { "contentType": "application/xml" @@ -37,28 +34,31 @@ "contentType": "application/json" } ], - "headers": [] + "statusCode": 200 } ] } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations", - "type": "Microsoft.ApiManagement/service/apis/operations", "name": "newoperations", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations", "properties": { - "displayName": "createUser2", "method": "POST", - "urlTemplate": "/user1", - "templateParameters": [], "description": "This can only be done by the logged in user.", + "displayName": "createUser2", + "templateParameters": [], + "urlTemplate": "/user1", "request": { "description": "Created user object", - "queryParameters": [], "headers": [], + "queryParameters": [], "representations": [ { "contentType": "application/json", @@ -69,8 +69,8 @@ }, "responses": [ { - "statusCode": 200, "description": "successful operation", + "headers": [], "representations": [ { "contentType": "application/xml" @@ -79,27 +79,27 @@ "contentType": "application/json" } ], - "headers": [] + "statusCode": 200 } ] } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations", - "type": "Microsoft.ApiManagement/service/apis/operations", "name": "newoperations", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations", "properties": { - "displayName": "createUser2", "method": "POST", - "urlTemplate": "/user1", - "templateParameters": [], "description": "This can only be done by the logged in user.", + "displayName": "createUser2", + "templateParameters": [], + "urlTemplate": "/user1", "request": { "description": "Created user object", - "queryParameters": [], "headers": [], + "queryParameters": [], "representations": [ { "contentType": "application/json", @@ -110,8 +110,8 @@ }, "responses": [ { - "statusCode": 200, "description": "successful operation", + "headers": [], "representations": [ { "contentType": "application/xml" @@ -120,11 +120,13 @@ "contentType": "application/json" } ], - "headers": [] + "statusCode": 200 } ] } } } - } + }, + "operationId": "ApiOperation_CreateOrUpdate", + "title": "ApiManagementCreateApiOperation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiOperationPolicy.json index cafb72931584..411ea93db239 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiOperationPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiOperationPolicy.json @@ -1,40 +1,42 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "5600b57e7e8880006a040001", "operationId": "5600b57e7e8880006a080001", - "policyId": "policy", "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "5600b57e7e8880006a040001", "parameters": { "properties": { "format": "xml", "value": " " } - } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", - "type": "Microsoft.ApiManagement/service/apis/operations/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", - "type": "Microsoft.ApiManagement/service/apis/operations/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "ApiOperationPolicy_CreateOrUpdate", + "title": "ApiManagementCreateApiOperationPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiOperationTag.json index cbf84501a6a4..d0ca5a8bedc5 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiOperationTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiOperationTag.json @@ -1,33 +1,35 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "5931a75ae4bbd512a88c680a", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "5931a75ae4bbd512a88c680b", - "operationId": "5931a75ae4bbd512a88c680a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagId": "tagId1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", - "type": "Microsoft.ApiManagement/service/tags", "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", "properties": { "displayName": "tag1" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", - "type": "Microsoft.ApiManagement/service/tags", "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", "properties": { "displayName": "tag1" } } } - } + }, + "operationId": "Tag_AssignToOperation", + "title": "ApiManagementCreateApiOperationTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiPolicy.json index 2ce5853e7f82..2d2059f7ef02 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiPolicy.json @@ -1,39 +1,41 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "5600b57e7e8880006a040001", - "policyId": "policy", - "If-Match": "*", "parameters": { "properties": { "format": "xml", "value": " " } - } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/policies/policy", - "type": "Microsoft.ApiManagement/service/apis/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/policies/policy", - "type": "Microsoft.ApiManagement/service/apis/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "ApiPolicy_CreateOrUpdate", + "title": "ApiManagementCreateApiPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json index 09edf76636e8..90c6c5a7e479 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json @@ -1,39 +1,41 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "5600b57e7e8880006a040001", - "policyId": "policy", - "If-Match": "*", "parameters": { "properties": { - "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n ", - "format": "rawxml" + "format": "rawxml", + "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n " } - } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/4c1a3bc6-89f9-46fe-a175-5d8984b25095/resourcegroups/Api-DF-West-US/providers/Microsoft.ApiManagement/service/samirmsiservice2/apis/echo-api/operations/create-resource/policies/policy", - "type": "Microsoft.ApiManagement/service/apis/operations/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "id": "/subscriptions/4c1a3bc6-89f9-46fe-a175-5d8984b25095/resourcegroups/Api-DF-West-US/providers/Microsoft.ApiManagement/service/samirmsiservice2/apis/echo-api/operations/create-resource/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/4c1a3bc6-89f9-46fe-a175-5d8984b25095/resourcegroups/Api-DF-West-US/providers/Microsoft.ApiManagement/service/samirmsiservice2/apis/echo-api/operations/create-resource/policies/policy", - "type": "Microsoft.ApiManagement/service/apis/operations/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "id": "/subscriptions/4c1a3bc6-89f9-46fe-a175-5d8984b25095/resourcegroups/Api-DF-West-US/providers/Microsoft.ApiManagement/service/samirmsiservice2/apis/echo-api/operations/create-resource/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n" } } } - } + }, + "operationId": "ApiPolicy_CreateOrUpdate", + "title": "ApiManagementCreateApiPolicyNonXmlEncoded" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiRelease.json index 612e2516ba85..905668b1f7f5 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiRelease.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiRelease.json @@ -1,44 +1,46 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "a1", - "releaseId": "testrev", "parameters": { "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", "notes": "yahooagain" } - } + }, + "releaseId": "testrev", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev", - "type": "Microsoft.ApiManagement/service/apis/releases", "name": "testrev", + "type": "Microsoft.ApiManagement/service/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", "createdDateTime": "2018-02-08T20:52:00.65Z", - "updatedDateTime": "2018-02-08T20:52:00.65Z", - "notes": "yahooagain" + "notes": "yahooagain", + "updatedDateTime": "2018-02-08T20:52:00.65Z" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev", - "type": "Microsoft.ApiManagement/service/apis/releases", "name": "testrev", + "type": "Microsoft.ApiManagement/service/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", "createdDateTime": "2018-02-08T20:52:00.65Z", - "updatedDateTime": "2018-02-08T20:52:00.65Z", - "notes": "yahooagain" + "notes": "yahooagain", + "updatedDateTime": "2018-02-08T20:52:00.65Z" } } } - } + }, + "operationId": "ApiRelease_CreateOrUpdate", + "title": "ApiManagementCreateApiRelease" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiRevisionFromExistingApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiRevisionFromExistingApi.json index c78c56ac2e0e..7e5ac16660af 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiRevisionFromExistingApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiRevisionFromExistingApi.json @@ -1,73 +1,75 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "echo-api;rev=3", "parameters": { "properties": { "path": "echo", + "apiRevisionDescription": "Creating a Revision of an existing API", "serviceUrl": "http://echoapi.cloudapp.net/apiv3", - "sourceApiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", - "apiRevisionDescription": "Creating a Revision of an existing API" + "sourceApiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", - "type": "Microsoft.ApiManagement/service/apis", "name": "echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", "properties": { - "displayName": "Echo API", - "apiRevision": "3", - "subscriptionRequired": true, - "serviceUrl": "http://echoapi.cloudapp.net/apiv3", "path": "echo", + "apiRevision": "3", + "apiRevisionDescription": "Creating a Revision of an existing API", + "displayName": "Echo API", "protocols": [ "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://echoapi.cloudapp.net/apiv3", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" }, - "apiRevisionDescription": "Creating a Revision of an existing API", - "provisioningState": "InProgress" + "subscriptionRequired": true } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", - "type": "Microsoft.ApiManagement/service/apis", "name": "echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", "properties": { - "displayName": "Echo API", - "apiRevision": "3", - "subscriptionRequired": true, - "serviceUrl": "http://echoapi.cloudapp.net/apiv3", "path": "echo", + "apiRevision": "3", + "apiRevisionDescription": "Creating a Revision of an existing API", + "displayName": "Echo API", "protocols": [ "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://echoapi.cloudapp.net/apiv3", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" }, - "apiRevisionDescription": "Creating a Revision of an existing API", - "provisioningState": "InProgress" + "subscriptionRequired": true } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiRevisionFromExistingApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiSchema.json index 3e9a870bb9a1..48e51d42203e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiSchema.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiSchema.json @@ -1,11 +1,7 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "59d6bb8f1f7fab13dc67ec9b", - "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", "parameters": { "properties": { "contentType": "application/vnd.ms-azure-apim.xsd+xml", @@ -13,18 +9,18 @@ "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } } - } + }, + "resourceGroupName": "rg1", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", - "type": "Microsoft.ApiManagement/service/apis/schemas", "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", "properties": { "contentType": "application/vnd.ms-azure-apim.xsd+xml", "document": { @@ -32,17 +28,17 @@ }, "provisioningState": "InProgress" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", - "type": "Microsoft.ApiManagement/service/apis/schemas", "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", "properties": { "contentType": "application/vnd.ms-azure-apim.xsd+xml", "document": { @@ -50,7 +46,13 @@ }, "provisioningState": "InProgress" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "ApiSchema_CreateOrUpdate", + "title": "ApiManagementCreateApiSchema" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiTag.json index 44a94c6e15cd..186073f735bc 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiTag.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "5931a75ae4bbd512a88c680b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagId": "tagId1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", - "type": "Microsoft.ApiManagement/service/tags", "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", "properties": { "displayName": "tag1" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", - "type": "Microsoft.ApiManagement/service/tags", "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", "properties": { "displayName": "tag1" } } } - } + }, + "operationId": "Tag_AssignToApi", + "title": "ApiManagementCreateApiTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiTagDescription.json index 31c21d2d2cc2..008aba626c37 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiTagDescription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiTagDescription.json @@ -1,47 +1,49 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "5931a75ae4bbd512a88c680b", - "tagDescriptionId": "tagId1", "parameters": { "properties": { "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API", - "externalDocsUrl": "http://some.url/additionaldoc", - "externalDocsDescription": "Description of the external docs resource" + "externalDocsDescription": "Description of the external docs resource", + "externalDocsUrl": "http://some.url/additionaldoc" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagDescriptionId": "tagId1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1", - "type": "Microsoft.ApiManagement/service/apis/tagDescriptions", "name": "tagId1", + "type": "Microsoft.ApiManagement/service/apis/tagDescriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1", "properties": { - "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", - "displayName": "tag1", "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API", + "displayName": "tag1", "externalDocsDescription": "some additional info", - "externalDocsUrl": "http://some_url.com" + "externalDocsUrl": "http://some_url.com", + "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1", - "type": "Microsoft.ApiManagement/service/apis/tagDescriptions", "name": "tagId1", + "type": "Microsoft.ApiManagement/service/apis/tagDescriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1", "properties": { - "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", - "displayName": "tag1", "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API", + "displayName": "tag1", "externalDocsDescription": "some additional info", - "externalDocsUrl": "http://some_url.com" + "externalDocsUrl": "http://some_url.com", + "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1" } } } - } + }, + "operationId": "ApiTagDescription_CreateOrUpdate", + "title": "ApiManagementCreateApiTagDescription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingImportOverrideServiceUrl.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingImportOverrideServiceUrl.json index df65b9f60ee3..0db0b6969063 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingImportOverrideServiceUrl.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingImportOverrideServiceUrl.json @@ -1,73 +1,75 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "apidocs", "parameters": { "properties": { "format": "swagger-link", - "value": "http://apimpimportviaurl.azurewebsites.net/api/apidocs/", "path": "petstoreapi123", - "serviceUrl": "http://petstore.swagger.wordnik.com/api" + "serviceUrl": "http://petstore.swagger.wordnik.com/api", + "value": "http://apimpimportviaurl.azurewebsites.net/api/apidocs/" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs", - "type": "Microsoft.ApiManagement/service/apis", "name": "apidocs", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs", "properties": { - "displayName": "Swagger Sample App", - "apiRevision": "1", - "description": "This is a sample server Petstore server. You can find out more about Swagger \n at http://swagger.wordnik.com or on irc.freenode.net, #swagger. For this sample,\n you can use the api key \"special-key\" to test the authorization filters", - "serviceUrl": "http://petstore.swagger.wordnik.com/api", "path": "petstoreapi123", + "description": "This is a sample server Petstore server. You can find out more about Swagger \n at http://swagger.wordnik.com or on irc.freenode.net, #swagger. For this sample,\n you can use the api key \"special-key\" to test the authorization filters", + "apiRevision": "1", + "displayName": "Swagger Sample App", + "isCurrent": true, "protocols": [ "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.wordnik.com/api", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs", - "type": "Microsoft.ApiManagement/service/apis", "name": "apidocs", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs", "properties": { - "displayName": "Swagger Sample App", - "apiRevision": "1", - "description": "This is a sample server Petstore server. You can find out more about Swagger \n at http://swagger.wordnik.com or on irc.freenode.net, #swagger. For this sample,\n you can use the api key \"special-key\" to test the authorization filters", - "serviceUrl": "http://petstore.swagger.wordnik.com/api", "path": "petstoreapi123", + "description": "This is a sample server Petstore server. You can find out more about Swagger \n at http://swagger.wordnik.com or on irc.freenode.net, #swagger. For this sample,\n you can use the api key \"special-key\" to test the authorization filters", + "apiRevision": "1", + "displayName": "Swagger Sample App", + "isCurrent": true, "protocols": [ "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.wordnik.com/api", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiUsingImportOverrideServiceUrl" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingOai3Import.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingOai3Import.json index c09957b12158..0e0cfcad9282 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingOai3Import.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingOai3Import.json @@ -1,70 +1,72 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "petstore", "parameters": { "properties": { "format": "openapi-link", - "value": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml", - "path": "petstore" + "path": "petstore", + "value": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", - "type": "Microsoft.ApiManagement/service/apis", "name": "petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", "properties": { - "displayName": "Swagger Petstore", - "apiRevision": "1", - "serviceUrl": "http://petstore.swagger.io/v1", "path": "petstore", + "apiRevision": "1", + "displayName": "Swagger Petstore", + "isCurrent": true, "protocols": [ "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v1", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", - "type": "Microsoft.ApiManagement/service/apis", "name": "petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", "properties": { - "displayName": "Swagger Petstore", - "apiRevision": "1", - "serviceUrl": "http://petstore.swagger.io/v1", "path": "petstore", + "apiRevision": "1", + "displayName": "Swagger Petstore", + "isCurrent": true, "protocols": [ "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v1", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiUsingOai3Import" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct.json index a479ea68881c..8a07ac666675 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct.json @@ -1,71 +1,73 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "petstore", "parameters": { "properties": { "format": "openapi-link", - "value": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml", "path": "petstore", - "translateRequiredQueryParameters": "template" + "translateRequiredQueryParameters": "template", + "value": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", - "type": "Microsoft.ApiManagement/service/apis", "name": "petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", "properties": { - "displayName": "Swagger Petstore", - "apiRevision": "1", - "serviceUrl": "http://petstore.swagger.io/v1", "path": "petstore", + "apiRevision": "1", + "displayName": "Swagger Petstore", + "isCurrent": true, "protocols": [ "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v1", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", - "type": "Microsoft.ApiManagement/service/apis", "name": "petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", "properties": { - "displayName": "Swagger Petstore", - "apiRevision": "1", - "serviceUrl": "http://petstore.swagger.io/v1", "path": "petstore", + "apiRevision": "1", + "displayName": "Swagger Petstore", + "isCurrent": true, "protocols": [ "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v1", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingSwaggerImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingSwaggerImport.json index 1ac0b4a423e8..e9e40a1f1f02 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingSwaggerImport.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingSwaggerImport.json @@ -1,72 +1,74 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "petstore", "parameters": { "properties": { "format": "swagger-link-json", - "value": "http://petstore.swagger.io/v2/swagger.json", - "path": "petstore" + "path": "petstore", + "value": "http://petstore.swagger.io/v2/swagger.json" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", - "type": "Microsoft.ApiManagement/service/apis", "name": "petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", "properties": { - "displayName": "Swagger Petstore", - "apiRevision": "1", - "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "serviceUrl": "http://petstore.swagger.io/v2", "path": "petstore", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "apiRevision": "1", + "displayName": "Swagger Petstore", + "isCurrent": true, "protocols": [ "http" ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v2", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", - "type": "Microsoft.ApiManagement/service/apis", "name": "petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", "properties": { - "displayName": "Swagger Petstore", - "apiRevision": "1", - "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "serviceUrl": "http://petstore.swagger.io/v2", "path": "petstore", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "apiRevision": "1", + "displayName": "Swagger Petstore", + "isCurrent": true, "protocols": [ "http" ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v2", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiUsingSwaggerImport" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingWadlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingWadlImport.json index bcd7ff628800..5f492ab28e2a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingWadlImport.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiUsingWadlImport.json @@ -1,72 +1,74 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "petstore", "parameters": { "properties": { "format": "wadl-link-json", - "value": "https://developer.cisco.com/media/wae-release-6-2-api-reference/wae-collector-rest-api/application.wadl", - "path": "collector" + "path": "collector", + "value": "https://developer.cisco.com/media/wae-release-6-2-api-reference/wae-collector-rest-api/application.wadl" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/collectorwadl", - "type": "Microsoft.ApiManagement/service/apis", "name": "collectorwadl", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/collectorwadl", "properties": { - "displayName": "http://localhost:8080/collector-northbound", - "apiRevision": "1", - "description": "", - "serviceUrl": "http://localhost:8080/collector-northbound", "path": "collector", + "description": "", + "apiRevision": "1", + "displayName": "http://localhost:8080/collector-northbound", + "isCurrent": true, "protocols": [ "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://localhost:8080/collector-northbound", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/collectorwadl", - "type": "Microsoft.ApiManagement/service/apis", "name": "collectorwadl", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/collectorwadl", "properties": { - "displayName": "http://localhost:8080/collector-northbound", - "apiRevision": "1", - "description": "", - "serviceUrl": "http://localhost:8080/collector-northbound", "path": "collector", + "description": "", + "apiRevision": "1", + "displayName": "http://localhost:8080/collector-northbound", + "isCurrent": true, "protocols": [ "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://localhost:8080/collector-northbound", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiUsingWadlImport" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiVersionSet.json index 06126abcef7e..01f94a1323cf 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiVersionSet.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiVersionSet.json @@ -1,42 +1,44 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "versionSetId": "api1", "parameters": { "properties": { + "description": "Version configuration", "displayName": "api set 1", - "versioningScheme": "Segment", - "description": "Version configuration" + "versioningScheme": "Segment" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "api1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1", - "type": "Microsoft.ApiManagement/service/api-version-sets", "name": "api1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1", "properties": { + "description": "Version configuration", "displayName": "api set 1", - "versioningScheme": "Segment", - "description": "Version configuration" + "versioningScheme": "Segment" } } }, "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1", - "type": "Microsoft.ApiManagement/service/api-version-sets", "name": "api1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1", "properties": { + "description": "Version configuration", "displayName": "api set 1", - "versioningScheme": "Segment", - "description": "Version configuration" + "versioningScheme": "Segment" } } } - } + }, + "operationId": "ApiVersionSet_CreateOrUpdate", + "title": "ApiManagementCreateApiVersionSet" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWiki.json index e2845b1faa28..d4973df63be0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWiki.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWiki.json @@ -1,9 +1,6 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d1f7558aa04f15146d9d8a", "parameters": { "properties": { @@ -16,14 +13,17 @@ } ] } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", - "type": "Microsoft.ApiManagement/service/apis/wikis", "name": "default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", "properties": { "documents": [ { @@ -36,11 +36,11 @@ } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", - "type": "Microsoft.ApiManagement/service/apis/wikis", "name": "default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", "properties": { "documents": [ { @@ -53,5 +53,7 @@ } } } - } + }, + "operationId": "ApiWiki_CreateOrUpdate", + "title": "ApiManagementCreateApiWiki" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWithMultipleAuthServers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWithMultipleAuthServers.json index 4484507a7c09..b849bb46a60e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWithMultipleAuthServers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWithMultipleAuthServers.json @@ -1,12 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "tempgroup", "parameters": { "properties": { + "path": "newapiPath", "description": "apidescription5200", "authenticationSettings": { "oAuth2AuthenticationSettings": [ @@ -20,69 +18,32 @@ } ] }, - "subscriptionKeyParameterNames": { - "header": "header4520", - "query": "query3037" - }, "displayName": "apiname1463", - "serviceUrl": "http://newechoapi.cloudapp.net/api", - "path": "newapiPath", "protocols": [ "https", "http" - ] - } - } - }, - "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/apis", - "name": "apiid9419", - "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "http://newechoapi.cloudapp.net/api", - "path": "newapiPath", - "protocols": [ - "http", - "https" - ], - "subscriptionKeyParameterNames": { - "header": "header4520", - "query": "query3037" - }, - "isCurrent": true, - "isOnline": true, - "provisioningState": "InProgress" + ], + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" } } }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/apis", "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "http://newechoapi.cloudapp.net/api", "path": "newapiPath", - "protocols": [ - "http", - "https" - ], + "description": "apidescription5200", + "apiRevision": "1", "authenticationSettings": { "oAuth2": { "authorizationServerId": "authorizationServerId2283", @@ -99,15 +60,56 @@ } ] }, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", "subscriptionKeyParameterNames": { "header": "header4520", "query": "query3037" - }, + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "path": "newapiPath", + "description": "apidescription5200", + "apiRevision": "1", + "displayName": "apiname1463", "isCurrent": true, "isOnline": true, - "provisioningState": "InProgress" + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiWithMultipleAuthServers" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json index 463a72e99f4d..39f505a12a80 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json @@ -1,123 +1,125 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "tempgroup", "parameters": { "properties": { + "path": "newapiPath", "description": "apidescription5200", "authenticationSettings": { "openidAuthenticationSettings": [ { - "openidProviderId": "openidProviderId2283", "bearerTokenSendingMethods": [ "authorizationHeader" - ] + ], + "openidProviderId": "openidProviderId2283" }, { - "openidProviderId": "openidProviderId2284", "bearerTokenSendingMethods": [ "authorizationHeader" - ] + ], + "openidProviderId": "openidProviderId2284" } ] }, - "subscriptionKeyParameterNames": { - "header": "header4520", - "query": "query3037" - }, "displayName": "apiname1463", - "serviceUrl": "http://newechoapi.cloudapp.net/api", - "path": "newapiPath", "protocols": [ "https", "http" - ] - } - } - }, - "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/apis", - "name": "apiid9419", - "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "http://newechoapi.cloudapp.net/api", - "path": "newapiPath", - "protocols": [ - "http", - "https" - ], - "subscriptionKeyParameterNames": { - "header": "header4520", - "query": "query3037" - }, - "isCurrent": true, - "isOnline": true, - "provisioningState": "InProgress" + ], + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" } } }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/apis", "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "http://newechoapi.cloudapp.net/api", "path": "newapiPath", - "protocols": [ - "http", - "https" - ], + "description": "apidescription5200", + "apiRevision": "1", "authenticationSettings": { "openid": { - "openidProviderId": "openidProviderId2283", "bearerTokenSendingMethods": [ "authorizationHeader" - ] + ], + "openidProviderId": "openidProviderId2283" }, "openidAuthenticationSettings": [ { - "openidProviderId": "openidProviderId2283", "bearerTokenSendingMethods": [ "authorizationHeader" - ] + ], + "openidProviderId": "openidProviderId2283" }, { - "openidProviderId": "openidProviderId2284", "bearerTokenSendingMethods": [ "authorizationHeader" - ] + ], + "openidProviderId": "openidProviderId2284" } ] }, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", "subscriptionKeyParameterNames": { "header": "header4520", "query": "query3037" - }, + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } + }, + "201": { + "body": { + "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "properties": { + "path": "newapiPath", + "description": "apidescription5200", + "apiRevision": "1", + "displayName": "apiname1463", "isCurrent": true, "isOnline": true, - "provisioningState": "InProgress" + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiWithMultipleOpenIdConnectProviders" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWithOpenIdConnect.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWithOpenIdConnect.json index 4799fef7aa2c..a379092f0fd8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWithOpenIdConnect.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateApiWithOpenIdConnect.json @@ -1,104 +1,106 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "tempgroup", "parameters": { "properties": { - "displayName": "Swagger Petstore", - "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "serviceUrl": "http://petstore.swagger.io/v2", "path": "petstore", - "protocols": [ - "https" - ], + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", "authenticationSettings": { "openid": { - "openidProviderId": "testopenid", "bearerTokenSendingMethods": [ "authorizationHeader" - ] + ], + "openidProviderId": "testopenid" } }, + "displayName": "Swagger Petstore", + "protocols": [ + "https" + ], + "serviceUrl": "http://petstore.swagger.io/v2", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58da4c4ccdae970a08121230", - "type": "Microsoft.ApiManagement/service/apis", "name": "58da4c4ccdae970a08121230", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58da4c4ccdae970a08121230", "properties": { - "displayName": "Swagger Petstore", - "apiRevision": "1", - "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "serviceUrl": "http://petstore.swagger.io/v2", "path": "petstore", - "protocols": [ - "https" - ], + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "apiRevision": "1", "authenticationSettings": { "openid": { - "openidProviderId": "testopenid", "bearerTokenSendingMethods": [ "authorizationHeader" - ] + ], + "openidProviderId": "testopenid" } }, + "displayName": "Swagger Petstore", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v2", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58da4c4ccdae970a08121230", - "type": "Microsoft.ApiManagement/service/apis", "name": "58da4c4ccdae970a08121230", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58da4c4ccdae970a08121230", "properties": { - "displayName": "Swagger Petstore", - "apiRevision": "1", - "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "serviceUrl": "http://petstore.swagger.io/v2", "path": "petstore", - "protocols": [ - "https" - ], + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "apiRevision": "1", "authenticationSettings": { "openid": { - "openidProviderId": "testopenid", "bearerTokenSendingMethods": [ "authorizationHeader" - ] + ], + "openidProviderId": "testopenid" } }, + "displayName": "Swagger Petstore", + "isCurrent": true, + "protocols": [ + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://petstore.swagger.io/v2", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateApiWithOpenIdConnect" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationAADAuthCode.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationAADAuthCode.json index 2dbf87aac301..fc7f2865a341 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationAADAuthCode.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationAADAuthCode.json @@ -1,50 +1,52 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "authorizationProviderId": "aadwithauthcode", "authorizationId": "authz2", + "authorizationProviderId": "aadwithauthcode", "parameters": { "properties": { "authorizationType": "OAuth2", "oauth2grantType": "AuthorizationCode" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz2", - "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", "name": "authz2", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz2", "properties": { "authorizationType": "OAuth2", - "oauth2grantType": "AuthorizationCode", - "status": "Error", "error": { "code": "Unauthenticated", "message": "This connection is not authenticated." - } + }, + "oauth2grantType": "AuthorizationCode", + "status": "Error" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz2", - "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", "name": "authz2", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz2", "properties": { "authorizationType": "OAuth2", - "oauth2grantType": "AuthorizationCode", - "status": "Error", "error": { "code": "Unauthenticated", "message": "This connection is not authenticated." - } + }, + "oauth2grantType": "AuthorizationCode", + "status": "Error" } } } - } + }, + "operationId": "Authorization_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationAADAuthCode" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationAADClientCred.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationAADClientCred.json index 3ab116e00273..9f2aea4fb757 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationAADClientCred.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationAADClientCred.json @@ -1,11 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "authorizationProviderId": "aadwithclientcred", "authorizationId": "authz1", + "authorizationProviderId": "aadwithclientcred", "parameters": { "properties": { "authorizationType": "OAuth2", @@ -15,14 +12,17 @@ "clientSecret": "clientsecretvalue" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz1", - "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", "name": "authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz1", "properties": { "authorizationType": "OAuth2", "oauth2grantType": "ClientCredentials", @@ -33,11 +33,11 @@ } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz1", - "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", "name": "authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz1", "properties": { "authorizationType": "OAuth2", "oauth2grantType": "ClientCredentials", @@ -48,5 +48,7 @@ } } } - } + }, + "operationId": "Authorization_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationAADClientCred" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationAccessPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationAccessPolicy.json index 2db46f034c67..b60a4eefa2c0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationAccessPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationAccessPolicy.json @@ -1,50 +1,52 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "authorizationProviderId": "aadwithauthcode", - "authorizationId": "authz1", "authorizationAccessPolicyId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "authorizationId": "authz1", + "authorizationProviderId": "aadwithauthcode", "parameters": { "properties": { "appIds": [ "d5f04bb0-ba78-4878-a43e-35a0b74fe315" ], - "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff", - "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab" + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies", - "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies/fe0bed83-631f-4149-bd0b-0464b1bc7cab", "properties": { "appIds": [ "d5f04bb0-ba78-4878-a43e-35a0b74fe315" ], - "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff", - "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab" + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies", - "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies/fe0bed83-631f-4149-bd0b-0464b1bc7cab", "properties": { "appIds": [ "d5f04bb0-ba78-4878-a43e-35a0b74fe315" ], - "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff", - "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab" + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff" } } } - } + }, + "operationId": "AuthorizationAccessPolicy_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationAccessPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderAADAuthCode.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderAADAuthCode.json index dfd59a070a76..9bb65e3e17b5 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderAADAuthCode.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderAADAuthCode.json @@ -1,74 +1,76 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "authorizationProviderId": "aadwithauthcode", "parameters": { "properties": { "displayName": "aadwithauthcode", "identityProvider": "aad", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "authorizationCode": { "clientId": "clientsecretid", "clientSecret": "clientsecretvalue", - "scopes": "User.Read.All Group.Read.All", - "resourceUri": "https://graph.microsoft.com" + "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", - "type": "Microsoft.ApiManagement/service/authorizationProviders", "name": "aadwithauthcode", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", "properties": { "displayName": "aadwithauthcode", "identityProvider": "aad", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "authorizationCode": { "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d", - "scopes": "User.Read.All Group.Read.All", "loginUri": "https://login.windows.net", "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All", "tenantId": "common" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", - "type": "Microsoft.ApiManagement/service/authorizationProviders", "name": "aadwithauthcode", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", "properties": { "displayName": "aadwithauthcode", "identityProvider": "aad", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "authorizationCode": { "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d", - "scopes": "User.Read.All Group.Read.All", "loginUri": "https://login.windows.net", "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All", "tenantId": "common" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } } } - } + }, + "operationId": "AuthorizationProvider_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationProviderAADAuthCode" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderAADClientCred.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderAADClientCred.json index 05ee69901bc1..d59a6f0db60a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderAADClientCred.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderAADClientCred.json @@ -1,70 +1,72 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "authorizationProviderId": "aadwithclientcred", "parameters": { "properties": { "displayName": "aadwithclientcred", "identityProvider": "aad", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "authorizationCode": { - "scopes": "User.Read.All Group.Read.All", - "resourceUri": "https://graph.microsoft.com" + "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred", - "type": "Microsoft.ApiManagement/service/authorizationProviders", "name": "aadwithclientcred", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred", "properties": { "displayName": "aadwithclientcred", "identityProvider": "aad", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "clientCredentials": { - "scopes": "User.Read.All Group.Read.All", "loginUri": "https://login.windows.net", "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All", "tenantId": "common" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred", - "type": "Microsoft.ApiManagement/service/authorizationProviders", "name": "aadwithclientcred", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred", "properties": { "displayName": "aadwithclientcred", "identityProvider": "aad", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "clientCredentials": { - "scopes": "User.Read.All Group.Read.All", "loginUri": "https://login.windows.net", "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All", "tenantId": "common" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } } } - } + }, + "operationId": "AuthorizationProvider_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationProviderAADClientCred" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderGenericOAuth2.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderGenericOAuth2.json index 630fd301da57..8d3ab7246718 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderGenericOAuth2.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderGenericOAuth2.json @@ -1,76 +1,78 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "authorizationProviderId": "eventbrite", "parameters": { "properties": { "displayName": "eventbrite", "identityProvider": "oauth2", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "authorizationCode": { + "authorizationUrl": "https://www.eventbrite.com/oauth/authorize", "clientId": "clientid", "clientSecret": "clientsecretvalue", - "scopes": null, - "authorizationUrl": "https://www.eventbrite.com/oauth/authorize", "refreshUrl": "https://www.eventbrite.com/oauth/token", + "scopes": null, "tokenUrl": "https://www.eventbrite.com/oauth/token" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/eventbrite", - "type": "Microsoft.ApiManagement/service/authorizationProviders", "name": "eventbrite", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/eventbrite", "properties": { "displayName": "eventbrite", "identityProvider": "oauth2", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "authorizationCode": { - "clientId": "clientid", - "scopes": null, "authorizationUrl": "https://www.eventbrite.com/oauth/authorize", + "clientId": "clientid", "refreshUrl": "https://www.eventbrite.com/oauth/token", + "scopes": null, "tokenUrl": "https://www.eventbrite.com/oauth/token" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/eventbrite", - "type": "Microsoft.ApiManagement/service/authorizationProviders", "name": "eventbrite", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/eventbrite", "properties": { "displayName": "eventbrite", "identityProvider": "oauth2", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "authorizationCode": { - "clientId": "clientid", - "scopes": null, "authorizationUrl": "https://www.eventbrite.com/oauth/authorize", + "clientId": "clientid", "refreshUrl": "https://www.eventbrite.com/oauth/token", + "scopes": null, "tokenUrl": "https://www.eventbrite.com/oauth/token" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } } } - } + }, + "operationId": "AuthorizationProvider_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationProviderGenericOAuth2" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderOOBGoogle.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderOOBGoogle.json index d42b13d6618a..5c356b8a7638 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderOOBGoogle.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationProviderOOBGoogle.json @@ -1,67 +1,69 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "authorizationProviderId": "google", "parameters": { "properties": { "displayName": "google", "identityProvider": "google", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "authorizationCode": { "clientId": "99999999-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com", "clientSecret": "clientsecretvalue", "scopes": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/google", - "type": "Microsoft.ApiManagement/service/authorizationProviders", "name": "google", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/google", "properties": { "displayName": "google", "identityProvider": "google", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "authorizationCode": { "clientId": "99999999-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com", "scopes": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/google", - "type": "Microsoft.ApiManagement/service/authorizationProviders", "name": "google", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/google", "properties": { "displayName": "google", "identityProvider": "google", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "authorizationCode": { "clientId": "99999999-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com", "scopes": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } } } - } + }, + "operationId": "AuthorizationProvider_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationProviderOOBGoogle" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationServer.json index 3bba5a549fe1..261eb7501522 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationServer.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateAuthorizationServer.json @@ -1,100 +1,102 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "authsid": "newauthServer", "parameters": { "properties": { - "displayName": "test2", - "useInTestConsole": false, - "useInApiDocumentation": true, "description": "test server", - "clientRegistrationEndpoint": "https://www.contoso.com/apps", "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", "authorizationMethods": [ "GET" ], - "tokenEndpoint": "https://www.contoso.com/oauth2/token", - "supportState": true, - "defaultScope": "read write", - "grantTypes": [ - "authorizationCode", - "implicit" - ], "bearerTokenSendingMethods": [ "authorizationHeader" ], "clientId": "1", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", "clientSecret": "2", + "defaultScope": "read write", + "displayName": "test2", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "resourceOwnerPassword": "pwd", "resourceOwnerUsername": "un", - "resourceOwnerPassword": "pwd" + "supportState": true, + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "useInApiDocumentation": true, + "useInTestConsole": false } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", - "type": "Microsoft.ApiManagement/service/authorizationServers", "name": "newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", "properties": { - "displayName": "test2", - "useInTestConsole": false, - "useInApiDocumentation": true, "description": "test server", - "clientRegistrationEndpoint": "https://www.contoso.com/apps", "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", "authorizationMethods": [ "GET" ], - "tokenEndpoint": "https://www.contoso.com/oauth2/token", - "supportState": true, + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", "defaultScope": "read write", + "displayName": "test2", "grantTypes": [ "authorizationCode", "implicit" ], - "bearerTokenSendingMethods": [ - "authorizationHeader" - ], - "clientId": "1", + "resourceOwnerPassword": "pwd", "resourceOwnerUsername": "un", - "resourceOwnerPassword": "pwd" + "supportState": true, + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "useInApiDocumentation": true, + "useInTestConsole": false } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", - "type": "Microsoft.ApiManagement/service/authorizationServers", "name": "newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", "properties": { - "displayName": "test2", - "useInTestConsole": false, - "useInApiDocumentation": true, "description": "test server", - "clientRegistrationEndpoint": "https://www.contoso.com/apps", "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", "authorizationMethods": [ "GET" ], - "tokenEndpoint": "https://www.contoso.com/oauth2/token", - "supportState": true, + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", "defaultScope": "read write", + "displayName": "test2", "grantTypes": [ "authorizationCode", "implicit" ], - "bearerTokenSendingMethods": [ - "authorizationHeader" - ], - "clientId": "1", + "resourceOwnerPassword": "pwd", "resourceOwnerUsername": "un", - "resourceOwnerPassword": "pwd" + "supportState": true, + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "useInApiDocumentation": true, + "useInTestConsole": false } } } - } + }, + "operationId": "AuthorizationServer_CreateOrUpdate", + "title": "ApiManagementCreateAuthorizationServer" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendProxyBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendProxyBackend.json index d73d3c1730fe..363a476aba36 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendProxyBackend.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendProxyBackend.json @@ -1,31 +1,14 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "backendId": "proxybackend", "parameters": { "properties": { "description": "description5308", - "url": "https://backendname2644/", - "protocol": "http", - "tls": { - "validateCertificateChain": true, - "validateCertificateName": true - }, - "proxy": { - "url": "http://192.168.1.1:8080", - "username": "Contoso\\admin", - "password": "" - }, "credentials": { - "query": { - "sv": [ - "xx", - "bb", - "cc" - ] + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" }, "header": { "x-my-1": [ @@ -33,31 +16,43 @@ "val2" ] }, - "authorization": { - "scheme": "Basic", - "parameter": "opensesma" + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] } - } + }, + "proxy": { + "password": "", + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin" + }, + "tls": { + "validateCertificateChain": true, + "validateCertificateName": true + }, + "url": "https://backendname2644/", + "protocol": "http" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", - "type": "Microsoft.ApiManagement/service/backends", "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", "properties": { "description": "description5308", - "url": "https://backendname2644/", - "protocol": "http", "credentials": { - "query": { - "sv": [ - "xx", - "bb", - "cc" - ] + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" }, "header": { "x-my-1": [ @@ -65,39 +60,39 @@ "val2" ] }, - "authorization": { - "scheme": "Basic", - "parameter": "opensesma" + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] } }, "proxy": { + "password": "", "url": "http://192.168.1.1:8080", - "username": "Contoso\\admin", - "password": "" + "username": "Contoso\\admin" }, "tls": { "validateCertificateChain": false, "validateCertificateName": false - } + }, + "url": "https://backendname2644/", + "protocol": "http" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", - "type": "Microsoft.ApiManagement/service/backends", "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", "properties": { "description": "description5308", - "url": "https://backendname2644/", - "protocol": "http", "credentials": { - "query": { - "sv": [ - "xx", - "bb", - "cc" - ] + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" }, "header": { "x-my-1": [ @@ -105,22 +100,29 @@ "val2" ] }, - "authorization": { - "scheme": "Basic", - "parameter": "opensesma" + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] } }, "proxy": { + "password": "", "url": "http://192.168.1.1:8080", - "username": "Contoso\\admin", - "password": "" + "username": "Contoso\\admin" }, "tls": { "validateCertificateChain": false, "validateCertificateName": false - } + }, + "url": "https://backendname2644/", + "protocol": "http" } } } - } + }, + "operationId": "Backend_CreateOrUpdate", + "title": "ApiManagementCreateBackendProxyBackend" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendServiceFabric.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendServiceFabric.json index b8ae0da40ced..06d5cd6af593 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendServiceFabric.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendServiceFabric.json @@ -1,87 +1,89 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "backendId": "sfbackend", "parameters": { "properties": { "description": "Service Fabric Test App 1", - "protocol": "http", - "url": "fabric:/mytestapp/mytestservice", "properties": { "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", "managementEndpoints": [ "https://somecluster.com" ], - "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "maxPartitionResolutionRetries": 5, "serverX509Names": [ { "name": "ServerCommonName1", "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" } - ], - "maxPartitionResolutionRetries": 5 + ] } - } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", - "type": "Microsoft.ApiManagement/service/backends", "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", "properties": { "description": "Service Fabric Test App 1", - "url": "fabric:/mytestapp/mytestservice", - "protocol": "http", "properties": { "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", "managementEndpoints": [ "https://somecluster.com" ], - "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "maxPartitionResolutionRetries": 5, "serverX509Names": [ { "name": "ServerCommonName1", "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" } - ], - "maxPartitionResolutionRetries": 5 + ] } - } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", - "type": "Microsoft.ApiManagement/service/backends", "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", "properties": { "description": "Service Fabric Test App 1", - "url": "fabric:/mytestapp/mytestservice", - "protocol": "http", "properties": { "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", "managementEndpoints": [ "https://somecluster.com" ], - "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "maxPartitionResolutionRetries": 5, "serverX509Names": [ { "name": "ServerCommonName1", "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" } - ], - "maxPartitionResolutionRetries": 5 + ] } - } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" } } } - } + }, + "operationId": "Backend_CreateOrUpdate", + "title": "ApiManagementCreateBackendServiceFabric" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendWithPriorityBasedLoadBalancer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendWithPriorityBasedLoadBalancer.json index 372bc988b430..9906d01d082d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendWithPriorityBasedLoadBalancer.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendWithPriorityBasedLoadBalancer.json @@ -1,9 +1,6 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "backendId": "priority-based-load-balancer", "parameters": { "properties": { @@ -29,19 +26,19 @@ ] } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/priority-based-load-balancer", - "type": "Microsoft.ApiManagement/service/backends", "name": "priority-based-load-balancer", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/priority-based-load-balancer", "properties": { - "title": null, "type": "Pool", - "url": null, - "protocol": null, "pool": { "services": [ { @@ -61,20 +58,20 @@ "priority": 2 } ] - } + }, + "title": null, + "url": null, + "protocol": null } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/priority-based-load-balancer", - "type": "Microsoft.ApiManagement/service/backends", "name": "priority-based-load-balancer", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/priority-based-load-balancer", "properties": { - "title": null, "type": "Pool", - "url": null, - "protocol": null, "pool": { "services": [ { @@ -94,9 +91,14 @@ "priority": 2 } ] - } + }, + "title": null, + "url": null, + "protocol": null } } } - } + }, + "operationId": "Backend_CreateOrUpdate", + "title": "ApiManagementCreateBackendWithPriorityBasedLoadBalancer" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendWithSimpleLoadBalancer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendWithSimpleLoadBalancer.json index 745a0976273b..0d4cd2cc68d4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendWithSimpleLoadBalancer.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendWithSimpleLoadBalancer.json @@ -1,9 +1,6 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "backendId": "simple-load-balancer", "parameters": { "properties": { @@ -19,19 +16,19 @@ ] } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/simple-load-balancer", - "type": "Microsoft.ApiManagement/service/backends", "name": "simple-load-balancer", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/simple-load-balancer", "properties": { - "title": null, "type": "Pool", - "url": null, - "protocol": null, "pool": { "services": [ { @@ -41,20 +38,20 @@ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2" } ] - } + }, + "title": null, + "url": null, + "protocol": null } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/simple-load-balancer", - "type": "Microsoft.ApiManagement/service/backends", "name": "simple-load-balancer", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/simple-load-balancer", "properties": { - "title": null, "type": "Pool", - "url": null, - "protocol": null, "pool": { "services": [ { @@ -64,9 +61,14 @@ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2" } ] - } + }, + "title": null, + "url": null, + "protocol": null } } } - } + }, + "operationId": "Backend_CreateOrUpdate", + "title": "ApiManagementCreateBackendWithSimpleLoadBalancer" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendWithWeightedLoadBalancer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendWithWeightedLoadBalancer.json index 223b2a3b79d1..5fa26138de8e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendWithWeightedLoadBalancer.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateBackendWithWeightedLoadBalancer.json @@ -1,9 +1,6 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "backendId": "weighted-load-balancer", "parameters": { "properties": { @@ -21,19 +18,19 @@ ] } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/weighted-load-balancer", - "type": "Microsoft.ApiManagement/service/backends", "name": "weighted-load-balancer", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/weighted-load-balancer", "properties": { - "title": null, "type": "Pool", - "url": null, - "protocol": null, "pool": { "services": [ { @@ -45,20 +42,20 @@ "weight": 25 } ] - } + }, + "title": null, + "url": null, + "protocol": null } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/weighted-load-balancer", - "type": "Microsoft.ApiManagement/service/backends", "name": "weighted-load-balancer", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/weighted-load-balancer", "properties": { - "title": null, "type": "Pool", - "url": null, - "protocol": null, "pool": { "services": [ { @@ -70,9 +67,14 @@ "weight": 25 } ] - } + }, + "title": null, + "url": null, + "protocol": null } } } - } + }, + "operationId": "Backend_CreateOrUpdate", + "title": "ApiManagementCreateBackendWithWeightedLoadBalancer" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateCache.json index 467b8fde4093..20c52068f62f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateCache.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateCache.json @@ -1,45 +1,47 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "cacheId": "c1", "parameters": { "properties": { - "connectionString": "apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False", "description": "Redis cache instances in West India", - "useFromLocation": "default", - "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1" + "connectionString": "apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False", + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1", + "useFromLocation": "default" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", - "type": "Microsoft.ApiManagement/service/caches", "name": "c1", + "type": "Microsoft.ApiManagement/service/caches", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", "properties": { - "useFromLocation": "default", "description": "Redis cache instances in West India", "connectionString": "{{5f7fbca77a891a2200f3db38}}", - "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1" + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1", + "useFromLocation": "default" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", - "type": "Microsoft.ApiManagement/service/caches", "name": "c1", + "type": "Microsoft.ApiManagement/service/caches", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", "properties": { - "useFromLocation": "default", "description": "Redis cache instances in West India", "connectionString": "{{5f7fbca77a891a2200f3db38}}", - "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1" + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1", + "useFromLocation": "default" } } } - } + }, + "operationId": "Cache_CreateOrUpdate", + "title": "ApiManagementCreateCache" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateCertificate.json index c44de9501904..182886e07755 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateCertificate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateCertificate.json @@ -1,41 +1,43 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "certificateId": "tempcert", "parameters": { "properties": { "data": "****************Base 64 Encoded Certificate *******************************", "password": "****Certificate Password******" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert", - "type": "Microsoft.ApiManagement/service/certificates", "name": "tempcert", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert", "properties": { + "expirationDate": "2018-03-17T21:55:07+00:00", "subject": "CN=contoso.com", - "thumbprint": "*******************3", - "expirationDate": "2018-03-17T21:55:07+00:00" + "thumbprint": "*******************3" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert", - "type": "Microsoft.ApiManagement/service/certificates", "name": "tempcert", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert", "properties": { + "expirationDate": "2018-03-17T21:55:07+00:00", "subject": "CN=contoso.com", - "thumbprint": "*******************3", - "expirationDate": "2018-03-17T21:55:07+00:00" + "thumbprint": "*******************3" } } } - } + }, + "operationId": "Certificate_CreateOrUpdate", + "title": "ApiManagementCreateCertificate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateCertificateWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateCertificateWithKeyVault.json index 48e6f042e7e8..110afb7687ad 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateCertificateWithKeyVault.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateCertificateWithKeyVault.json @@ -1,9 +1,6 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "certificateId": "templateCertkv", "parameters": { "properties": { @@ -12,48 +9,53 @@ "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", - "type": "Microsoft.ApiManagement/service/certificates", "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", "properties": { - "subject": "CN=*.msitesting.net", - "thumbprint": "EA**********************9AD690", "expirationDate": "2037-01-01T07:00:00Z", "keyVault": { - "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-22T00:24:53.3191468Z" - } - } + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", - "type": "Microsoft.ApiManagement/service/certificates", "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", "properties": { - "subject": "CN=*.msitesting.net", - "thumbprint": "EA**********************9AD690", "expirationDate": "2037-01-01T07:00:00Z", "keyVault": { - "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-22T00:24:53.3191468Z" - } - } + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" } } } - } + }, + "operationId": "Certificate_CreateOrUpdate", + "title": "ApiManagementCreateCertificateWithKeyVault" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateClientApplication.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateClientApplication.json index 342fa93aaa2c..bbc6983230f9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateClientApplication.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateClientApplication.json @@ -1,48 +1,50 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "clientApplicationId": "testAppId", "parameters": { "properties": { - "displayName": "Test Application", "description": "This is just an example application", + "displayName": "Test Application", "ownerId": "/users/userId" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId", - "type": "Microsoft.ApiManagement/service/clientApplications", "name": "testAppId", + "type": "Microsoft.ApiManagement/service/clientApplications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId", "properties": { - "displayName": "Test Application", - "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId", - "state": "active", "description": "This is just an example application", + "displayName": "Test Application", "entraApplicationId": "00000000-0000-0000-0000-000000000000", - "entraTenantId": "00000000-0000-0000-0000-000000000010" + "entraTenantId": "00000000-0000-0000-0000-000000000010", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId", + "state": "active" } } }, "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId", - "type": "Microsoft.ApiManagement/service/clientApplications", "name": "testAppId", + "type": "Microsoft.ApiManagement/service/clientApplications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId", "properties": { - "displayName": "Test Application", - "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId", - "state": "active", "description": "This is just an example application", + "displayName": "Test Application", "entraApplicationId": "00000000-0000-0000-0000-000000000001", - "entraTenantId": "00000000-0000-0000-0000-000000000011" + "entraTenantId": "00000000-0000-0000-0000-000000000011", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId", + "state": "active" } } } - } + }, + "operationId": "ClientApplication_CreateOrUpdate", + "title": "ApiManagementCreateProduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateClientApplicationProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateClientApplicationProductLink.json index 345af749fea5..68af8000a02d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateClientApplicationProductLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateClientApplicationProductLink.json @@ -1,37 +1,39 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "clientApplicationId": "testAppId", "clientApplicationProductLinkId": "link1", "parameters": { "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link1", - "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link1", "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link1", - "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link1", "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter" } } } - } + }, + "operationId": "ClientApplicationProductLink_Create", + "title": "ApiManagementCreateClientApplicationProductLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateContentType.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateContentType.json index b03df4ba45e7..83747d30a7e3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateContentType.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateContentType.json @@ -1,177 +1,179 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "contentTypeId": "page", "parameters": { "properties": { "name": "Page", - "description": "A regular page", "schema": { + "additionalProperties": false, "properties": { "en_us": { "type": "object", + "additionalProperties": false, "properties": { - "title": { - "title": "Title", - "description": "Page title. This property gets included in SEO attributes.", - "type": "string", - "indexed": true - }, "description": { - "title": "Description", + "type": "string", "description": "Page description. This property gets included in SEO attributes.", + "indexed": true, + "title": "Description" + }, + "documentId": { "type": "string", - "indexed": true + "description": "Reference to page content document.", + "title": "Document ID" }, "keywords": { - "title": "Keywords", - "description": "Page keywords. This property gets included in SEO attributes.", "type": "string", - "indexed": true + "description": "Page keywords. This property gets included in SEO attributes.", + "indexed": true, + "title": "Keywords" }, "permalink": { - "title": "Permalink", - "description": "Page permalink, e.g. '/about'.", "type": "string", - "indexed": true + "description": "Page permalink, e.g. '/about'.", + "indexed": true, + "title": "Permalink" }, - "documentId": { - "title": "Document ID", - "description": "Reference to page content document.", - "type": "string" + "title": { + "type": "string", + "description": "Page title. This property gets included in SEO attributes.", + "indexed": true, + "title": "Title" } }, - "additionalProperties": false, "required": [ "title", "permalink", "documentId" ] } - }, - "additionalProperties": false + } }, + "description": "A regular page", "version": "1.0.0" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/contentTypes/page", - "type": "Microsoft.ApiManagement/service/contentTypes", "name": "page", + "type": "Microsoft.ApiManagement/service/contentTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/contentTypes/page", "properties": { "name": "Page", - "description": "A regular page", "schema": { + "additionalProperties": false, "properties": { "en_us": { "type": "object", + "additionalProperties": false, "properties": { - "title": { - "title": "Title", - "description": "Page title. This property gets included in SEO attributes.", - "type": "string", - "indexed": true - }, "description": { - "title": "Description", + "type": "string", "description": "Page description. This property gets included in SEO attributes.", + "indexed": true, + "title": "Description" + }, + "documentId": { "type": "string", - "indexed": true + "description": "Reference to page content document.", + "title": "Document ID" }, "keywords": { - "title": "Keywords", - "description": "Page keywords. This property gets included in SEO attributes.", "type": "string", - "indexed": true + "description": "Page keywords. This property gets included in SEO attributes.", + "indexed": true, + "title": "Keywords" }, "permalink": { - "title": "Permalink", - "description": "Page permalink, e.g. '/about'.", "type": "string", - "indexed": true + "description": "Page permalink, e.g. '/about'.", + "indexed": true, + "title": "Permalink" }, - "documentId": { - "title": "Document ID", - "description": "Reference to page content document.", - "type": "string" + "title": { + "type": "string", + "description": "Page title. This property gets included in SEO attributes.", + "indexed": true, + "title": "Title" } }, - "additionalProperties": false, "required": [ "title", "permalink", "documentId" ] } - }, - "additionalProperties": false + } }, + "description": "A regular page", "version": "1.0.0" } } }, "201": { "body": { - "id": "/contentTypes/page", - "type": "Microsoft.ApiManagement/service/contentTypes", "name": "page", + "type": "Microsoft.ApiManagement/service/contentTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/contentTypes/page", "properties": { "name": "Page", - "description": "A regular page", "schema": { + "additionalProperties": false, "properties": { "en_us": { "type": "object", + "additionalProperties": false, "properties": { - "title": { - "title": "Title", - "description": "Page title. This property gets included in SEO attributes.", - "type": "string", - "indexed": true - }, "description": { - "title": "Description", + "type": "string", "description": "Page description. This property gets included in SEO attributes.", + "indexed": true, + "title": "Description" + }, + "documentId": { "type": "string", - "indexed": true + "description": "Reference to page content document.", + "title": "Document ID" }, "keywords": { - "title": "Keywords", - "description": "Page keywords. This property gets included in SEO attributes.", "type": "string", - "indexed": true + "description": "Page keywords. This property gets included in SEO attributes.", + "indexed": true, + "title": "Keywords" }, "permalink": { - "title": "Permalink", - "description": "Page permalink, e.g. '/about'.", "type": "string", - "indexed": true + "description": "Page permalink, e.g. '/about'.", + "indexed": true, + "title": "Permalink" }, - "documentId": { - "title": "Document ID", - "description": "Reference to page content document.", - "type": "string" + "title": { + "type": "string", + "description": "Page title. This property gets included in SEO attributes.", + "indexed": true, + "title": "Title" } }, - "additionalProperties": false, "required": [ "title", "permalink", "documentId" ] } - }, - "additionalProperties": false + } }, + "description": "A regular page", "version": "1.0.0" } } } - } + }, + "operationId": "ContentType_CreateOrUpdate", + "title": "ApiManagementCreateContentType" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateContentTypeContentItem.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateContentTypeContentItem.json index fd5f1394ca0a..ab167eaaac33 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateContentTypeContentItem.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateContentTypeContentItem.json @@ -1,55 +1,57 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "contentTypeId": "page", "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "contentTypeId": "page", "parameters": { "properties": { "en_us": { - "title": "About", "description": "Short story about the company.", - "keywords": "company, about", "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", - "permalink": "/about" + "keywords": "company, about", + "permalink": "/about", + "title": "About" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", - "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", "name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", "properties": { "en_us": { - "title": "About", "description": "Short story about the company.", - "keywords": "company, about", "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", - "permalink": "/about" + "keywords": "company, about", + "permalink": "/about", + "title": "About" } } } }, "201": { "body": { - "id": "/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", - "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", "name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", "properties": { "en_us": { - "title": "About", "description": "Short story about the company.", - "keywords": "company, about", "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", - "permalink": "/about" + "keywords": "company, about", + "permalink": "/about", + "title": "About" } } } } - } + }, + "operationId": "ContentItem_CreateOrUpdate", + "title": "ApiManagementCreateContentTypeContentItem" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateDiagnostic.json index 0002750a7278..c73e4fb9685a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateDiagnostic.json @@ -1,159 +1,161 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "diagnosticId": "applicationinsights", "parameters": { "properties": { "alwaysLog": "allErrors", - "loggerId": "/loggers/azuremonitor", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/loggers/azuremonitor", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "loggerId": "/loggers/azuremonitor", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "loggerId": "/loggers/applicationinsights", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/loggers/azuremonitor", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } } } - } + }, + "operationId": "Diagnostic_CreateOrUpdate", + "title": "ApiManagementCreateDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateDocumentation.json index 58063db8aaca..e68d4755955e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateDocumentation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateDocumentation.json @@ -1,39 +1,41 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "documentationId": "57d1f7558aa04f15146d9d8a", "parameters": { "properties": { - "title": "Title", - "content": "content" + "content": "content", + "title": "Title" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", - "type": "Microsoft.ApiManagement/service/documentations", "name": "57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/documentations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", "properties": { - "title": "Title", - "content": "content" + "content": "content", + "title": "Title" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", - "type": "Microsoft.ApiManagement/service/documentations", "name": "57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/documentations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", "properties": { - "title": "Title", - "content": "content" + "content": "content", + "title": "Title" } } } - } + }, + "operationId": "Documentation_CreateOrUpdate", + "title": "ApiManagementCreateDocumentation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateEHLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateEHLogger.json index adc20f595767..3db11b1921bb 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateEHLogger.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateEHLogger.json @@ -1,51 +1,53 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "loggerId": "eh1", "parameters": { "properties": { - "loggerType": "azureEventHub", "description": "adding a new logger", "credentials": { "name": "hydraeventhub", "connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********=" - } + }, + "loggerType": "azureEventHub" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1", - "type": "Microsoft.ApiManagement/service/loggers", "name": "eh1", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1", "properties": { - "loggerType": "azureEventHub", "description": "adding a new logger", "credentials": { "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" }, - "isBuffered": true + "isBuffered": true, + "loggerType": "azureEventHub" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1", - "type": "Microsoft.ApiManagement/service/loggers", "name": "eh1", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1", "properties": { - "loggerType": "azureEventHub", "description": "adding a new logger", "credentials": { "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" }, - "isBuffered": true + "isBuffered": true, + "loggerType": "azureEventHub" } } } - } + }, + "operationId": "Logger_CreateOrUpdate", + "title": "ApiManagementCreateEHLogger" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGateway.json index c7f1d9bfba15..85f0f35263c6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGateway.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGateway.json @@ -1,9 +1,6 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "gatewayId": "gw1", "parameters": { "properties": { @@ -12,14 +9,17 @@ "name": "my location" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", - "type": "Microsoft.ApiManagement/service/gateways", "name": "a1", + "type": "Microsoft.ApiManagement/service/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", "properties": { "description": "my gateway 1", "locationData": { @@ -28,11 +28,11 @@ } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", - "type": "Microsoft.ApiManagement/service/gateways", "name": "a1", + "type": "Microsoft.ApiManagement/service/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", "properties": { "description": "my gateway 1", "locationData": { @@ -41,5 +41,7 @@ } } } - } + }, + "operationId": "Gateway_CreateOrUpdate", + "title": "ApiManagementCreateGateway" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayApi.json index 43a2f17a5f8a..2ccc10648bdb 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayApi.json @@ -1,61 +1,63 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "gatewayId": "gw1", "apiId": "echo-api", + "gatewayId": "gw1", "parameters": { "properties": { "provisioningState": "created" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/echo-api", - "type": "Microsoft.ApiManagement/service/gateways/apis", "name": "echo-api", + "type": "Microsoft.ApiManagement/service/gateways/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/echo-api", "properties": { - "displayName": "EchoApi", - "apiRevision": "1", - "serviceUrl": "https://contoso.com/apis/echo", "path": "", + "apiRevision": "1", + "displayName": "EchoApi", + "isCurrent": true, "protocols": [ "http", "https" ], + "serviceUrl": "https://contoso.com/apis/echo", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true + } } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/echo-api", - "type": "Microsoft.ApiManagement/service/gateways/apis", "name": "echo-api", + "type": "Microsoft.ApiManagement/service/gateways/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/echo-api", "properties": { - "displayName": "EchoApi", - "apiRevision": "1", - "serviceUrl": "https://contoso.com/apis/echo", "path": "", + "apiRevision": "1", + "displayName": "EchoApi", + "isCurrent": true, "protocols": [ "http", "https" ], + "serviceUrl": "https://contoso.com/apis/echo", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true + } } } } - } + }, + "operationId": "GatewayApi_CreateOrUpdate", + "title": "ApiManagementCreateGatewayApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayCertificateAuthority.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayCertificateAuthority.json index bb150f8e6dda..45d5511a1013 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayCertificateAuthority.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayCertificateAuthority.json @@ -1,37 +1,39 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "gatewayId": "gw1", "certificateId": "cert1", + "gatewayId": "gw1", "parameters": { "properties": { "isTrusted": false } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", - "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", "name": "cert1", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", "properties": { "isTrusted": false } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", - "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", "name": "cert1", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", "properties": { "isTrusted": false } } } - } + }, + "operationId": "GatewayCertificateAuthority_CreateOrUpdate", + "title": "ApiManagementCreateGatewayCertificateAuthority" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayConfigConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayConfigConnection.json index 18378b1578c1..f06bae9aafda 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayConfigConnection.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayConfigConnection.json @@ -1,42 +1,44 @@ { "parameters": { - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "gatewayName": "standard-gw-01", "configConnectionName": "gcc-01", + "gatewayName": "standard-gw-01", "parameters": { "properties": { "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001" } - } + }, + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", "name": "gcc-1", "type": "Microsoft.ApiManagement/gateways/configConnections", "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", "properties": { + "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net", "provisioningState": "Succeeded", - "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001", - "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net" + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", "name": "gcc-1", "type": "Microsoft.ApiManagement/gateways/configConnections", "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", "properties": { + "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net", "provisioningState": "Succeeded", - "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001", - "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net" + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001" } } } - } + }, + "operationId": "ApiGatewayConfigConnection_CreateOrUpdate", + "title": "ApiManagementCreateGatewayConfigConnection" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayHostnameConfiguration.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayHostnameConfiguration.json index 452fd4151fa1..2ab90d18e5ed 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayHostnameConfiguration.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGatewayHostnameConfiguration.json @@ -1,52 +1,54 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "gatewayId": "gw1", "hcId": "default", "parameters": { "properties": { - "hostname": "*", "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "hostname": "*", + "http2Enabled": true, "negotiateClientCertificate": false, "tls10Enabled": false, - "tls11Enabled": false, - "http2Enabled": true + "tls11Enabled": false } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", - "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", "name": "default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", "properties": { - "hostname": "*", "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "hostname": "*", + "http2Enabled": true, "negotiateClientCertificate": false, "tls10Enabled": false, - "tls11Enabled": false, - "http2Enabled": true + "tls11Enabled": false } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", - "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", "name": "default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", "properties": { - "hostname": "*", "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "hostname": "*", + "http2Enabled": true, "negotiateClientCertificate": false, "tls10Enabled": false, - "tls11Enabled": false, - "http2Enabled": true + "tls11Enabled": false } } } - } + }, + "operationId": "GatewayHostnameConfiguration_CreateOrUpdate", + "title": "ApiManagementCreateGatewayHostnameConfiguration" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGlobalSchema1.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGlobalSchema1.json index d4bcb25cc799..e467ed895ff1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGlobalSchema1.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGlobalSchema1.json @@ -1,52 +1,54 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "schemaId": "schema1", "parameters": { "properties": { "description": "sample schema description", "schemaType": "xml", "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } - } + }, + "resourceGroupName": "rg1", + "schemaId": "schema1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", - "type": "Microsoft.ApiManagement/service/schemas", "name": "schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", "properties": { "description": "sample schema description", + "provisioningState": "InProgress", "schemaType": "xml", - "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n", - "provisioningState": "InProgress" + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", - "type": "Microsoft.ApiManagement/service/schemas", "name": "schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", "properties": { "description": "sample schema description", + "provisioningState": "InProgress", "schemaType": "xml", - "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n", - "provisioningState": "InProgress" + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "GlobalSchema_CreateOrUpdate", + "title": "ApiManagementCreateSchema1" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGlobalSchema2.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGlobalSchema2.json index dab490f52aa6..d358f45190c2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGlobalSchema2.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGlobalSchema2.json @@ -1,20 +1,19 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "schemaId": "schema1", "parameters": { "properties": { "description": "sample schema description", - "schemaType": "json", "document": { + "type": "object", "$id": "https://example.com/person.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "Person", - "type": "object", "properties": { + "age": { + "type": "integer", + "description": "Age in years which must be equal to or greater than zero.", + "minimum": 0 + }, "firstName": { "type": "string", "description": "The person's first name." @@ -22,36 +21,36 @@ "lastName": { "type": "string", "description": "The person's last name." - }, - "age": { - "description": "Age in years which must be equal to or greater than zero.", - "type": "integer", - "minimum": 0 } - } - } + }, + "title": "Person" + }, + "schemaType": "json" } - } + }, + "resourceGroupName": "rg1", + "schemaId": "schema1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", - "type": "Microsoft.ApiManagement/service/schemas", "name": "schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", "properties": { "description": "sample schema description", - "schemaType": "json", "document": { + "type": "object", "$id": "https://example.com/person.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "Person", - "type": "object", "properties": { + "age": { + "type": "integer", + "description": "Age in years which must be equal to or greater than zero.", + "minimum": 0 + }, "firstName": { "type": "string", "description": "The person's first name." @@ -59,36 +58,36 @@ "lastName": { "type": "string", "description": "The person's last name." - }, - "age": { - "description": "Age in years which must be equal to or greater than zero.", - "type": "integer", - "minimum": 0 } - } + }, + "title": "Person" }, - "provisioningState": "InProgress" + "provisioningState": "InProgress", + "schemaType": "json" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", - "type": "Microsoft.ApiManagement/service/schemas", "name": "schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", "properties": { "description": "sample schema description", - "schemaType": "json", "document": { + "type": "object", "$id": "https://example.com/person.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "Person", - "type": "object", "properties": { + "age": { + "type": "integer", + "description": "Age in years which must be equal to or greater than zero.", + "minimum": 0 + }, "firstName": { "type": "string", "description": "The person's first name." @@ -96,17 +95,20 @@ "lastName": { "type": "string", "description": "The person's last name." - }, - "age": { - "description": "Age in years which must be equal to or greater than zero.", - "type": "integer", - "minimum": 0 } - } + }, + "title": "Person" }, - "provisioningState": "InProgress" + "provisioningState": "InProgress", + "schemaType": "json" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "GlobalSchema_CreateOrUpdate", + "title": "ApiManagementCreateSchema2" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGraphQLApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGraphQLApi.json index a47a804082b0..d309f7a90aba 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGraphQLApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGraphQLApi.json @@ -1,80 +1,82 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "tempgroup", "parameters": { "properties": { - "description": "apidescription5200", - "displayName": "apiname1463", "type": "graphql", - "serviceUrl": "https://api.spacex.land/graphql", "path": "graphql-api", + "description": "apidescription5200", + "displayName": "apiname1463", "protocols": [ "http", "https" - ] + ], + "serviceUrl": "https://api.spacex.land/graphql" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/apis", "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "https://api.spacex.land/graphql", "type": "graphql", "path": "graphql-api", - "protocols": [ - "https", - "https" - ], + "description": "apidescription5200", + "apiRevision": "1", "authenticationSettings": null, - "subscriptionKeyParameterNames": null, + "displayName": "apiname1463", "isCurrent": true, "isOnline": true, - "provisioningState": "InProgress" + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "https://api.spacex.land/graphql", + "subscriptionKeyParameterNames": null } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/apis", "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "https://api.spacex.land/graphql", "type": "graphql", "path": "graphql-api", - "protocols": [ - "http", - "https" - ], + "description": "apidescription5200", + "apiRevision": "1", "authenticationSettings": null, - "subscriptionKeyParameterNames": null, + "displayName": "apiname1463", "isCurrent": true, "isOnline": true, - "provisioningState": "InProgress" + "protocols": [ + "https", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "https://api.spacex.land/graphql", + "subscriptionKeyParameterNames": null } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateGraphQLApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGraphQLApiResolver.json index ff917220f73e..1edae1671fa2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGraphQLApiResolver.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGraphQLApiResolver.json @@ -1,43 +1,45 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "someAPI", - "resolverId": "newResolver", "parameters": { "properties": { - "displayName": "Query Users", "path": "Query/users", - "description": "A GraphQL Resolver example" + "description": "A GraphQL Resolver example", + "displayName": "Query Users" } - } + }, + "resolverId": "newResolver", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/someAPI/resolvers/newResolver", - "type": "Microsoft.ApiManagement/service/apis/resolvers", "name": "newResolver", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/someAPI/resolvers/newResolver", "properties": { - "displayName": "Query Users", "path": "Query/users", - "description": "A GraphQL Resolver example" + "description": "A GraphQL Resolver example", + "displayName": "Query Users" } } }, "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/someAPI/resolvers/newResolver", - "type": "Microsoft.ApiManagement/service/apis/resolvers", "name": "newResolver", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/someAPI/resolvers/newResolver", "properties": { - "displayName": "Query Users", "path": "Query/users", - "description": "A GraphQL Resolver example" + "description": "A GraphQL Resolver example", + "displayName": "Query Users" } } } - } + }, + "operationId": "GraphQLApiResolver_CreateOrUpdate", + "title": "ApiManagementCreateGraphQLApiResolver" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGraphQLApiResolverPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGraphQLApiResolverPolicy.json index 7c2bd772129c..f812f0df22d2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGraphQLApiResolverPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGraphQLApiResolverPolicy.json @@ -1,26 +1,26 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "5600b57e7e8880006a040001", - "resolverId": "5600b57e7e8880006a080001", - "policyId": "policy", - "If-Match": "*", "parameters": { "properties": { "format": "xml", "value": "GET/api/users" } - } + }, + "policyId": "policy", + "resolverId": "5600b57e7e8880006a080001", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/resolvers/5600b57e7e8880006a080001/policies/policy", - "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/resolvers/5600b57e7e8880006a080001/policies/policy", "properties": { "value": "\r\n \r\n GET\r\n\r\n/api/users\r\n\r\n" } @@ -28,13 +28,15 @@ }, "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/resolvers/5600b57e7e8880006a080001/policies/policy", - "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/resolvers/5600b57e7e8880006a080001/policies/policy", "properties": { "value": "\r\n \r\n GET\r\n\r\n/api/users\r\n\r\n" } } } - } + }, + "operationId": "GraphQLApiResolverPolicy_CreateOrUpdate", + "title": "ApiManagementCreateGraphQLApiResolverPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGroup.json index fd364ec19ad3..1701d6bc99bd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGroup.json @@ -1,38 +1,40 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "groupId": "tempgroup", "parameters": { "properties": { "displayName": "temp group" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup", - "type": "Microsoft.ApiManagement/service/groups", "name": "tempgroup", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup", "properties": { - "displayName": "temp group", - "type": "custom" + "type": "custom", + "displayName": "temp group" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup", - "type": "Microsoft.ApiManagement/service/groups", "name": "tempgroup", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup", "properties": { - "displayName": "temp group", - "type": "custom" + "type": "custom", + "displayName": "temp group" } } } - } + }, + "operationId": "Group_CreateOrUpdate", + "title": "ApiManagementCreateGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGroupExternal.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGroupExternal.json index d520ca17c68a..16249c40a217 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGroupExternal.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGroupExternal.json @@ -1,45 +1,47 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "groupId": "aadGroup", "parameters": { "properties": { - "displayName": "NewGroup (samiraad.onmicrosoft.com)", - "description": "new group to test", "type": "external", + "description": "new group to test", + "displayName": "NewGroup (samiraad.onmicrosoft.com)", "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup", - "type": "Microsoft.ApiManagement/service/groups", "name": "aadGroup", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup", "properties": { - "displayName": "NewGroup (samiraad.onmicrosoft.com)", - "description": "new group to test", "type": "external", + "description": "new group to test", + "displayName": "NewGroup (samiraad.onmicrosoft.com)", "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup", - "type": "Microsoft.ApiManagement/service/groups", "name": "aadGroup", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup", "properties": { - "displayName": "NewGroup (samiraad.onmicrosoft.com)", - "description": "new group to test", "type": "external", + "description": "new group to test", + "displayName": "NewGroup (samiraad.onmicrosoft.com)", "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" } } } - } + }, + "operationId": "Group_CreateOrUpdate", + "title": "ApiManagementCreateGroupExternal" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGroupUser.json index dbe2ae52b436..0320dba6980f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGroupUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGroupUser.json @@ -1,44 +1,46 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "groupId": "tempgroup", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userId": "59307d350af58404d8a26300" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/59307d350af58404d8a26300", - "type": "Microsoft.ApiManagement/service/groups/users", "name": "59307d350af58404d8a26300", + "type": "Microsoft.ApiManagement/service/groups/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/59307d350af58404d8a26300", "properties": { + "email": "testuser1@live.com", "firstName": "test", + "groups": [], + "identities": [], "lastName": "user", - "email": "testuser1@live.com", - "state": "active", "registrationDate": "2017-06-01T20:46:45.437Z", - "groups": [], - "identities": [] + "state": "active" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/59307d350af58404d8a26300", - "type": "Microsoft.ApiManagement/service/groups/users", "name": "59307d350af58404d8a26300", + "type": "Microsoft.ApiManagement/service/groups/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/59307d350af58404d8a26300", "properties": { + "email": "testuser1@live.com", "firstName": "test", + "groups": [], + "identities": [], "lastName": "user", - "email": "testuser1@live.com", - "state": "active", "registrationDate": "2017-06-01T20:46:45.437Z", - "groups": [], - "identities": [] + "state": "active" } } } - } + }, + "operationId": "GroupUser_Create", + "title": "ApiManagementCreateGroupUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGrpcApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGrpcApi.json index 3ffd63896535..ac2f66847d21 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGrpcApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateGrpcApi.json @@ -1,77 +1,79 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "tempgroup", "parameters": { "properties": { - "description": "apidescription5200", - "displayName": "apiname1463", "type": "grpc", - "serviceUrl": "https://your-api-hostname/samples", + "format": "grpc-link", "path": "grpc-api", + "description": "apidescription5200", + "displayName": "apiname1463", "protocols": [ "https" ], - "format": "grpc-link", + "serviceUrl": "https://your-api-hostname/samples", "value": "https://raw.githubusercontent.com/kedacore/keda/main/pkg/scalers/externalscaler/externalscaler.proto" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/apis", "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "https://your-api-hostname/samples", "type": "grpc", "path": "grpc-api", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": null, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, "protocols": [ "https" ], - "authenticationSettings": null, - "subscriptionKeyParameterNames": null, - "isCurrent": true, - "isOnline": true + "serviceUrl": "https://your-api-hostname/samples", + "subscriptionKeyParameterNames": null } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/apis", "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "https://your-api-hostname/samples", "type": "grpc", "path": "grpc-api", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": null, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, "protocols": [ "https" ], - "authenticationSettings": null, - "subscriptionKeyParameterNames": null, - "isCurrent": true, - "isOnline": true + "serviceUrl": "https://your-api-hostname/samples", + "subscriptionKeyParameterNames": null } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateGrpcApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateIdentityProvider.json index fa5f6cae5477..0dc9aac7b421 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateIdentityProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateIdentityProvider.json @@ -1,39 +1,41 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "identityProviderName": "facebook", "parameters": { "properties": { "clientId": "facebookid", "clientSecret": "facebookapplicationsecret" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook", - "type": "Microsoft.ApiManagement/service/identityProviders", "name": "Facebook", + "type": "Microsoft.ApiManagement/service/identityProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook", "properties": { - "clientId": "facebookid", - "type": "facebook" + "type": "facebook", + "clientId": "facebookid" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook", - "type": "Microsoft.ApiManagement/service/identityProviders", "name": "Facebook", + "type": "Microsoft.ApiManagement/service/identityProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook", "properties": { - "clientId": "facebookid", - "type": "facebook" + "type": "facebook", + "clientId": "facebookid" } } } - } + }, + "operationId": "IdentityProvider_CreateOrUpdate", + "title": "ApiManagementCreateIdentityProvider" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json index e86220dafa92..3e7f276ee512 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json @@ -1,280 +1,282 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { + "location": "West US", "properties": { + "additionalLocations": [ + { + "disableGateway": true, + "location": "East US", + "sku": { + "name": "Premium", + "capacity": 1 + } + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "gateway1.msitesting.net", - "encodedCertificate": "****** Base 64 Encoded Certificate ************", "certificatePassword": "Password", - "defaultSslBinding": true + "defaultSslBinding": true, + "encodedCertificate": "****** Base 64 Encoded Certificate ************", + "hostName": "gateway1.msitesting.net" }, { "type": "Management", - "hostName": "mgmt.msitesting.net", + "certificatePassword": "Password", "encodedCertificate": "****** Base 64 Encoded Certificate ************", - "certificatePassword": "Password" + "hostName": "mgmt.msitesting.net" }, { "type": "Portal", - "hostName": "portal1.msitesting.net", + "certificatePassword": "Password", "encodedCertificate": "****** Base 64 Encoded Certificate ************", - "certificatePassword": "Password" + "hostName": "portal1.msitesting.net" }, { "type": "ConfigurationApi", - "hostName": "configuration-api.msitesting.net", + "certificatePassword": "Password", "encodedCertificate": "****** Base 64 Encoded Certificate ************", - "certificatePassword": "Password" + "hostName": "configuration-api.msitesting.net" } ], "publisherEmail": "apim@autorestsdk.com", "publisherName": "autorestsdk", - "additionalLocations": [ - { - "location": "East US", - "sku": { - "name": "Premium", - "capacity": 1 - }, - "disableGateway": true - } - ], - "virtualNetworkType": "None", - "apiVersionConstraint": { - "minApiVersion": "2019-01-01" - } + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 }, - "location": "West US", "tags": { "tag1": "value1", "tag2": "value2", "tag3": "value3" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" - }, + "etag": "AAAAAAACXok=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "West US", - "etag": "AAAAAAACXoo=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Created", - "targetProvisioningState": "Activating", - "createdAtUtc": "2019-12-18T08:04:26.9492661Z", + "additionalLocations": [ + { + "disableGateway": true, + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "location": "East US", + "publicIPAddresses": [ + "23.101.138.153" + ], + "sku": { + "name": "Premium", + "capacity": 1 + } + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, + "createdAtUtc": "2019-12-18T06:26:20.3348609Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", + "defaultSslBinding": false, "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": false + "negotiateClientCertificate": false }, { "type": "Proxy", - "hostName": "gateway1.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" }, - "defaultSslBinding": true + "defaultSslBinding": true, + "hostName": "gateway1.msitesting.net", + "negotiateClientCertificate": false }, { "type": "Management", - "hostName": "mgmt.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" }, - "defaultSslBinding": false + "defaultSslBinding": false, + "hostName": "mgmt.msitesting.net", + "negotiateClientCertificate": false }, { "type": "Portal", - "hostName": "portal1.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" }, - "defaultSslBinding": false + "defaultSslBinding": false, + "hostName": "portal1.msitesting.net", + "negotiateClientCertificate": false }, { "type": "ConfigurationApi", - "hostName": "configuration-api.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" }, - "defaultSslBinding": false + "defaultSslBinding": false, + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false } ], - "additionalLocations": [ - { - "location": "East US", - "sku": { - "name": "Premium", - "capacity": 1 - }, - "disableGateway": true - } + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.91.32.113" ], - "virtualNetworkType": "None", - "disableGateway": false, - "apiVersionConstraint": { - "minApiVersion": "2019-01-01" - } + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" - }, + "etag": "AAAAAAACXoo=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "West US", - "etag": "AAAAAAACXok=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2019-12-18T06:26:20.3348609Z", - "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", + "additionalLocations": [ + { + "disableGateway": true, + "location": "East US", + "sku": { + "name": "Premium", + "capacity": 1 + } + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, + "createdAtUtc": "2019-12-18T08:04:26.9492661Z", + "disableGateway": false, "hostnameConfigurations": [ { "type": "Proxy", + "defaultSslBinding": false, "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": false + "negotiateClientCertificate": false }, { "type": "Proxy", - "hostName": "gateway1.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" }, - "defaultSslBinding": true + "defaultSslBinding": true, + "hostName": "gateway1.msitesting.net", + "negotiateClientCertificate": false }, { "type": "Management", - "hostName": "mgmt.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" }, - "defaultSslBinding": false + "defaultSslBinding": false, + "hostName": "mgmt.msitesting.net", + "negotiateClientCertificate": false }, { "type": "Portal", - "hostName": "portal1.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" }, - "defaultSslBinding": false + "defaultSslBinding": false, + "hostName": "portal1.msitesting.net", + "negotiateClientCertificate": false }, { "type": "ConfigurationApi", - "hostName": "configuration-api.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2", - "subject": "CN=*.msitesting.net" - }, - "defaultSslBinding": false - } - ], - "publicIPAddresses": [ - "13.91.32.113" - ], - "additionalLocations": [ - { - "location": "East US", - "sku": { - "name": "Premium", - "capacity": 1 + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2" }, - "publicIPAddresses": [ - "23.101.138.153" - ], - "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", - "disableGateway": true + "defaultSslBinding": false, + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false } ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, - "apiVersionConstraint": { - "minApiVersion": "2019-01-01" - } + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateMultiRegionServiceWithCustomHostname" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNamedValue.json index 23c7244b8a73..a0133bece8a8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNamedValue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNamedValue.json @@ -1,64 +1,66 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "namedValueId": "testprop2", "parameters": { "properties": { "displayName": "prop3name", - "value": "propValue", + "secret": false, "tags": [ "foo", "bar" ], - "secret": false + "value": "propValue" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", - "type": "Microsoft.ApiManagement/service/namedValues", "name": "testprop2", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", "properties": { "displayName": "prop3name", - "value": "propValue", + "provisioningState": "InProgress", + "secret": false, "tags": [ "foo", "bar" ], - "secret": false, - "provisioningState": "InProgress" + "value": "propValue" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", - "type": "Microsoft.ApiManagement/service/namedValues", "name": "testprop2", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", "properties": { "displayName": "prop3name", - "value": "propValue", + "provisioningState": "InProgress", + "secret": false, "tags": [ "foo", "bar" ], - "secret": false, - "provisioningState": "InProgress" + "value": "propValue" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "NamedValue_CreateOrUpdate", + "title": "ApiManagementCreateNamedValue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNamedValueWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNamedValueWithKeyVault.json index cd75868234c3..c8a7e5b7fc7c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNamedValueWithKeyVault.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNamedValueWithKeyVault.json @@ -1,9 +1,6 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "namedValueId": "testprop6", "parameters": { "properties": { @@ -12,70 +9,75 @@ "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" }, + "secret": true, "tags": [ "foo", "bar" - ], - "secret": true + ] } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", - "type": "Microsoft.ApiManagement/service/namedValues", "name": "testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", "properties": { "displayName": "prop6namekv", "keyVault": { - "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret", "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-11T00:54:31.8024882Z" - } + }, + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" }, + "provisioningState": "InProgress", + "secret": true, "tags": [ "foo", "bar" - ], - "secret": true, - "provisioningState": "InProgress" + ] } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", - "type": "Microsoft.ApiManagement/service/namedValues", "name": "testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", "properties": { "displayName": "prop6namekv", "keyVault": { - "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret", "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-11T00:54:31.8024882Z" - } + }, + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" }, + "provisioningState": "InProgress", + "secret": true, "tags": [ "foo", "bar" - ], - "secret": true, - "provisioningState": "InProgress" + ] } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "NamedValue_CreateOrUpdate", + "title": "ApiManagementCreateNamedValueWithKeyVault" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNotification.json index 883188d3315b..a5c86fc95a87 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNotification.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNotification.json @@ -1,19 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "notificationName": "RequestPublisherNotificationMessage" + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", - "type": "Microsoft.ApiManagement/service/notifications", "name": "RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", "properties": { - "title": "Subscription requests (requiring approval)", "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", "recipients": { "emails": [ @@ -24,9 +23,12 @@ "users": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" ] - } + }, + "title": "Subscription requests (requiring approval)" } } } - } + }, + "operationId": "Notification_CreateOrUpdate", + "title": "ApiManagementCreateNotification" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNotificationRecipientEmail.json index 2725a93595c0..b012405fdecc 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNotificationRecipientEmail.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNotificationRecipientEmail.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "email": "foobar@live.com", "notificationName": "RequestPublisherNotificationMessage", - "email": "foobar@live.com" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", - "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", "name": "foobar@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", "properties": { "email": "foobar@live.com" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", - "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", "name": "foobar@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", "properties": { "email": "foobar@live.com" } } } - } + }, + "operationId": "NotificationRecipientEmail_CreateOrUpdate", + "title": "ApiManagementCreateNotificationRecipientEmail" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNotificationRecipientUser.json index df90bc40ec2c..cbdf96bcb453 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNotificationRecipientUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateNotificationRecipientUser.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userId": "576823d0a40f7e74ec07d642" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", - "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", "name": "576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", "properties": { "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", - "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", "name": "576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", "properties": { "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" } } } - } + }, + "operationId": "NotificationRecipientUser_CreateOrUpdate", + "title": "ApiManagementCreateNotificationRecipientUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateODataApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateODataApi.json index af30bdd53d0c..6059aaec3fd9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateODataApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateODataApi.json @@ -1,82 +1,84 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "tempgroup", "parameters": { "properties": { - "description": "apidescription5200", - "displayName": "apiname1463", "type": "odata", - "serviceUrl": "https://services.odata.org/TripPinWebApiService", + "format": "odata-link", "path": "odata-api", + "description": "apidescription5200", + "displayName": "apiname1463", "protocols": [ "http", "https" ], - "format": "odata-link", + "serviceUrl": "https://services.odata.org/TripPinWebApiService", "value": "https://services.odata.org/TripPinWebApiService/$metadata" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/apis", "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "https://services.odata.org/TripPinWebApiService", "type": "odata", "path": "odata-api", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": null, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, "protocols": [ "http", "https" ], - "authenticationSettings": null, - "subscriptionKeyParameterNames": null, - "isCurrent": true, - "isOnline": true, - "provisioningState": "InProgress" + "provisioningState": "InProgress", + "serviceUrl": "https://services.odata.org/TripPinWebApiService", + "subscriptionKeyParameterNames": null } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/apis", "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "https://services.odata.org/TripPinWebApiService", "type": "odata", "path": "odata-api", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": null, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, "protocols": [ "http", "https" ], - "authenticationSettings": null, - "subscriptionKeyParameterNames": null, - "isCurrent": true, - "isOnline": true, - "provisioningState": "InProgress" + "provisioningState": "InProgress", + "serviceUrl": "https://services.odata.org/TripPinWebApiService", + "subscriptionKeyParameterNames": null } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateODataApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json index ad317ad291e9..6095c1c5ba2f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json @@ -1,49 +1,51 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "opid": "templateOpenIdConnect3", "parameters": { "properties": { - "displayName": "templateoidprovider3", - "metadataEndpoint": "https://oidprovider-template3.net", "clientId": "oidprovidertemplate3", "clientSecret": "x", - "useInTestConsole": false, - "useInApiDocumentation": true + "displayName": "templateoidprovider3", + "metadataEndpoint": "https://oidprovider-template3.net", + "useInApiDocumentation": true, + "useInTestConsole": false } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3", - "type": "Microsoft.ApiManagement/service/openidconnectproviders", "name": "templateOpenIdConnect3", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3", "properties": { + "clientId": "oidprovidertemplate3", "displayName": "templateoidprovider3", "metadataEndpoint": "https://oidprovider-template3.net", - "clientId": "oidprovidertemplate3", - "useInTestConsole": false, - "useInApiDocumentation": true + "useInApiDocumentation": true, + "useInTestConsole": false } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3", - "type": "Microsoft.ApiManagement/service/openidconnectproviders", "name": "templateOpenIdConnect3", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3", "properties": { + "clientId": "oidprovidertemplate3", "displayName": "templateoidprovider3", "metadataEndpoint": "https://oidprovider-template3.net", - "clientId": "oidprovidertemplate3", - "useInTestConsole": false, - "useInApiDocumentation": true + "useInApiDocumentation": true, + "useInTestConsole": false } } } - } + }, + "operationId": "OpenIdConnectProvider_CreateOrUpdate", + "title": "ApiManagementCreateOpenIdConnectProvider" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePolicy.json index 09c093333311..52c41f18f83d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePolicy.json @@ -1,37 +1,39 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "policyId": "policy", "parameters": { "properties": { "format": "xml", "value": "\r\n \r\n \r\n \r\n \r\n \r\n" } - } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", - "type": "Microsoft.ApiManagement/service/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", - "type": "Microsoft.ApiManagement/service/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "Policy_CreateOrUpdate", + "title": "ApiManagementCreatePolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePolicyFragment.json index 139c73f422a8..5da20b07d4d3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePolicyFragment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePolicyFragment.json @@ -1,9 +1,6 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "id": "policyFragment1", "parameters": { "properties": { @@ -11,42 +8,47 @@ "description": "A policy fragment example", "value": "" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", - "type": "Microsoft.ApiManagement/service/policyFragments", "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", "properties": { "format": "xml", "description": "A policy fragment example", - "value": "", - "provisioningState": "InProgress" + "provisioningState": "InProgress", + "value": "" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", - "type": "Microsoft.ApiManagement/service/policyFragments", "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", "properties": { "format": "xml", "description": "A policy fragment example", - "value": "", - "provisioningState": "InProgress" + "provisioningState": "InProgress", + "value": "" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "PolicyFragment_CreateOrUpdate", + "title": "ApiManagementCreatePolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePolicyRestriction.json index 2211f1cca9b4..a0ec472466f5 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePolicyRestriction.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePolicyRestriction.json @@ -1,40 +1,42 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "policyRestrictionId": "policyRestriction1", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { - "scope": "Sample Path to the policy document.", - "requireBase": "true" + "requireBase": "true", + "scope": "Sample Path to the policy document." } - } + }, + "policyRestrictionId": "policyRestriction1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", - "type": "Microsoft.ApiManagement/service/policyFragments", "name": "policyRestrictions1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", "properties": { - "scope": "Sample Path to the policy document.", - "requireBase": "true" + "requireBase": "true", + "scope": "Sample Path to the policy document." } } }, "201": { "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", - "type": "Microsoft.ApiManagement/service/policyFragments", "name": "policyRestrictions2", + "type": "Microsoft.ApiManagement/service/policyFragments", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", "properties": { - "scope": "Sample Path to the policy document.", - "requireBase": "true" + "requireBase": "true", + "scope": "Sample Path to the policy document." } } } - } + }, + "operationId": "PolicyRestriction_CreateOrUpdate", + "title": "ApiManagementCreatePolicyRestriction" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePortalConfig.json index 5df31e7abec2..6324c8aeabfd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePortalConfig.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePortalConfig.json @@ -1,22 +1,22 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "portalConfigId": "default", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { - "enableBasicAuth": true, - "signin": { - "require": false + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] }, - "signup": { - "termsOfService": { - "text": "I agree to the service terms and conditions.", - "requireConsent": false - } + "csp": { + "allowedSources": [ + "*.contoso.com" + ], + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ] }, "delegation": { "delegateRegistration": false, @@ -24,39 +24,43 @@ "delegationUrl": null, "validationKey": null }, - "csp": { - "mode": "reportOnly", - "reportUri": [ - "https://report.contoso.com" - ], - "allowedSources": [ - "*.contoso.com" - ] + "enableBasicAuth": true, + "signin": { + "require": false }, - "cors": { - "allowedOrigins": [ - "https://contoso.com" - ] + "signup": { + "termsOfService": { + "requireConsent": false, + "text": "I agree to the service terms and conditions." + } } } - } + }, + "portalConfigId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", - "type": "Microsoft.ApiManagement/service/portalconfigs", "name": "default", + "type": "Microsoft.ApiManagement/service/portalconfigs", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", "properties": { - "enableBasicAuth": true, - "signin": { - "require": false + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] }, - "signup": { - "termsOfService": { - "text": "I agree to the service terms and conditions.", - "requireConsent": false - } + "csp": { + "allowedSources": [ + "*.contoso.com" + ], + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ] }, "delegation": { "delegateRegistration": false, @@ -64,22 +68,20 @@ "delegationUrl": null, "validationKey": null }, - "csp": { - "mode": "reportOnly", - "reportUri": [ - "https://report.contoso.com" - ], - "allowedSources": [ - "*.contoso.com" - ] + "enableBasicAuth": true, + "signin": { + "require": false }, - "cors": { - "allowedOrigins": [ - "https://contoso.com" - ] + "signup": { + "termsOfService": { + "requireConsent": false, + "text": "I agree to the service terms and conditions." + } } } } } - } + }, + "operationId": "PortalConfig_CreateOrUpdate", + "title": "ApiManagementCreatePortalConfig" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePortalRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePortalRevision.json index 8f40d496f171..e6c5d075fd21 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePortalRevision.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreatePortalRevision.json @@ -1,37 +1,39 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "portalRevisionId": "20201112101010", "parameters": { "properties": { "description": "portal revision 1", "isCurrent": true } - } + }, + "portalRevisionId": "20201112101010", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2024-10-01-preview&asyncId=5faf089b1d9a026694220e0c&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5faf089b1d9a026694220e0c?api-version=2024-10-01-preview" - }, "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010", - "type": "Microsoft.ApiManagement/service/portalRevisions", "name": "20201112101010", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010", "properties": { "description": "portal revision 1", - "statusDetails": null, - "status": "completed", - "isCurrent": true, "createdDateTime": "2020-11-13T22:28:43.657Z", - "updatedDateTime": "2020-11-13T22:29:22.68Z", - "provisioningState": "InProgress" + "isCurrent": true, + "provisioningState": "InProgress", + "status": "completed", + "statusDetails": null, + "updatedDateTime": "2020-11-13T22:29:22.68Z" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5faf089b1d9a026694220e0c?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2024-10-01-preview&asyncId=5faf089b1d9a026694220e0c&asyncCode=201" } } - } + }, + "operationId": "PortalRevision_CreateOrUpdate", + "title": "ApiManagementCreatePortalRevision" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProduct.json index 3fd63e2b0bc9..b25ab5767d01 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProduct.json @@ -1,42 +1,44 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "testproduct", "parameters": { "properties": { "displayName": "Test Template ProductName 4" } - } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct", - "type": "Microsoft.ApiManagement/service/products", "name": "testproduct", + "type": "Microsoft.ApiManagement/service/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct", "properties": { - "displayName": "Test Template ProductName 4", - "subscriptionRequired": true, "approvalRequired": false, - "state": "notPublished" + "displayName": "Test Template ProductName 4", + "state": "notPublished", + "subscriptionRequired": true } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct", - "type": "Microsoft.ApiManagement/service/products", "name": "testproduct", + "type": "Microsoft.ApiManagement/service/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct", "properties": { - "displayName": "Test Template ProductName 4", - "subscriptionRequired": true, "approvalRequired": false, - "state": "notPublished" + "displayName": "Test Template ProductName 4", + "state": "notPublished", + "subscriptionRequired": true } } } - } + }, + "operationId": "Product_CreateOrUpdate", + "title": "ApiManagementCreateProduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductApi.json index 5ec1d04c298d..7322d52247fc 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductApi.json @@ -1,56 +1,58 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "echo-api", "productId": "testproduct", - "apiId": "echo-api" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b", - "type": "Microsoft.ApiManagement/service/apis", "name": "5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b", "properties": { - "displayName": "EchoApi", - "apiRevision": "1", - "serviceUrl": "https://contoso.com/apis/echo", "path": "", + "apiRevision": "1", + "displayName": "EchoApi", + "isCurrent": true, "protocols": [ "http", "https" ], + "serviceUrl": "https://contoso.com/apis/echo", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true + } } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b", - "type": "Microsoft.ApiManagement/service/apis", "name": "5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b", "properties": { - "displayName": "EchoApi", - "apiRevision": "1", - "serviceUrl": "https://contoso.com/apis/echo", "path": "", + "apiRevision": "1", + "displayName": "EchoApi", + "isCurrent": true, "protocols": [ "http", "https" ], + "serviceUrl": "https://contoso.com/apis/echo", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true + } } } } - } + }, + "operationId": "ProductApi_CreateOrUpdate", + "title": "ApiManagementCreateProductApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductApiLink.json index 22506764471b..6ef64421c144 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductApiLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductApiLink.json @@ -1,37 +1,39 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "testproduct", "apiLinkId": "link1", "parameters": { "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" } - } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/products/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/products/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" } } } - } + }, + "operationId": "ProductApiLink_CreateOrUpdate", + "title": "ApiManagementCreateProductApiLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductGroup.json index 866c89b4ec59..ccb5c215babb 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductGroup.json @@ -1,38 +1,40 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupId": "templateGroup", "productId": "testproduct", - "groupId": "templateGroup" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup", - "type": "Microsoft.ApiManagement/service/products/groups", "name": "templateGroup", + "type": "Microsoft.ApiManagement/service/products/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup", "properties": { - "displayName": "Template Group", + "type": "custom", "description": "group created via Template", "builtIn": false, - "type": "custom" + "displayName": "Template Group" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup", - "type": "Microsoft.ApiManagement/service/products/groups", "name": "templateGroup", + "type": "Microsoft.ApiManagement/service/products/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup", "properties": { - "displayName": "Template Group", + "type": "custom", "description": "group created via Template", "builtIn": false, - "type": "custom" + "displayName": "Template Group" } } } - } + }, + "operationId": "ProductGroup_CreateOrUpdate", + "title": "ApiManagementCreateProductGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductGroupLink.json index b8190ad54000..ee0d6c72444c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductGroupLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductGroupLink.json @@ -1,37 +1,39 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "testproduct", "groupLinkId": "link1", "parameters": { "properties": { "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" } - } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groupLinkId/link1", - "type": "Microsoft.ApiManagement/service/products/groupLinkId", "name": "link1", + "type": "Microsoft.ApiManagement/service/products/groupLinkId", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groupLinkId/link1", "properties": { "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groupLinkId/link1", - "type": "Microsoft.ApiManagement/service/products/groupLinkId", "name": "link1", + "type": "Microsoft.ApiManagement/service/products/groupLinkId", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groupLinkId/link1", "properties": { "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" } } } - } + }, + "operationId": "ProductGroupLink_CreateOrUpdate", + "title": "ApiManagementCreateProductGroupLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductPolicy.json index c0ece9dacca6..4a379aa3f079 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductPolicy.json @@ -1,38 +1,40 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "5702e97e5157a50f48dce801", - "policyId": "policy", "parameters": { "properties": { "format": "xml", "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } - } + }, + "policyId": "policy", + "productId": "5702e97e5157a50f48dce801", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5702e97e5157a50f48dce801/policies/policy", - "type": "Microsoft.ApiManagement/service/products/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5702e97e5157a50f48dce801/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5702e97e5157a50f48dce801/policies/policy", - "type": "Microsoft.ApiManagement/service/products/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5702e97e5157a50f48dce801/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "ProductPolicy_CreateOrUpdate", + "title": "ApiManagementCreateProductPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductTag.json index d5179f36d83c..02e11f418ff4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductTag.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "productId": "5931a75ae4bbd512a88c680b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagId": "tagId1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", - "type": "Microsoft.ApiManagement/service/tags", "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", "properties": { "displayName": "tag1" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", - "type": "Microsoft.ApiManagement/service/tags", "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", "properties": { "displayName": "tag1" } } } - } + }, + "operationId": "Tag_AssignToProduct", + "title": "ApiManagementCreateProductTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductWiki.json index 7aabcbb88c46..a9d698454981 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductWiki.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateProductWiki.json @@ -1,10 +1,6 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "57d1f7558aa04f15146d9d8a", "parameters": { "properties": { "documents": [ @@ -16,14 +12,18 @@ } ] } - } + }, + "productId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", - "type": "Microsoft.ApiManagement/service/products/wikis", "name": "default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", "properties": { "documents": [ { @@ -36,11 +36,11 @@ } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", - "type": "Microsoft.ApiManagement/service/products/wikis", "name": "default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", "properties": { "documents": [ { @@ -53,5 +53,7 @@ } } } - } + }, + "operationId": "ProductWiki_CreateOrUpdate", + "title": "ApiManagementCreateProductWiki" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateService.json index 3f4e4052b19a..91da915c925c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateService.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateService.json @@ -1,10 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { + "location": "South Central US", "properties": { "publisherEmail": "foo@contoso.com", "publisherName": "foo" @@ -13,128 +11,132 @@ "name": "Developer", "capacity": 1 }, - "location": "South Central US", "tags": { "Name": "Contoso", "Test": "User" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "api-version": "2024-10-01-preview" - }, + "etag": "AAAAAAAmREI=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "East US", - "etag": "AAAAAAAmRAM=", "properties": { - "publisherEmail": "samir@microsoft.com", - "publisherName": "foo", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Created", - "targetProvisioningState": "Activating", "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], - "virtualNetworkType": "None", - "disableGateway": false, + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv1", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.90.229.33" + ], "publicNetworkAccess": "Enabled", - "platformVersion": "undetermined", - "releaseChannel": "Default" + "publisherEmail": "samir@microsoft.com", + "publisherName": "foo", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Standard", "capacity": 1 }, "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", "createdBy": "user@contoso.com", "createdByType": "User", - "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", "lastModifiedBy": "user@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "api-version": "2024-10-01-preview" - }, + "etag": "AAAAAAAmRAM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "East US", - "etag": "AAAAAAAmREI=", "properties": { - "publisherEmail": "samir@microsoft.com", - "publisherName": "foo", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "disableGateway": false, "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], - "publicIPAddresses": [ - "13.90.229.33" - ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "undetermined", + "provisioningState": "Created", "publicNetworkAccess": "Enabled", - "platformVersion": "stv1" + "publisherEmail": "samir@microsoft.com", + "publisherName": "foo", + "releaseChannel": "Default", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" }, "sku": { "name": "Standard", "capacity": 1 }, "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", "createdBy": "user@contoso.com", "createdByType": "User", - "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", "lastModifiedBy": "user@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateService" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceHavingMsi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceHavingMsi.json index 7212385bae39..f10ac9b40171 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceHavingMsi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceHavingMsi.json @@ -1,10 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "West US", "properties": { "publisherEmail": "apim@autorestsdk.com", "publisherName": "autorestsdk" @@ -13,121 +14,122 @@ "name": "Consumption", "capacity": 0 }, - "identity": { - "type": "SystemAssigned" - }, - "location": "West US", "tags": { "tag1": "value1", "tag2": "value2", "tag3": "value3" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" + "etag": "AAAAAAAAWiU=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "SystemAssigned", + "principalId": "dfb9a757-df69-4966-a8d0-711a9cd8ffb4", + "tenantId": "00000000-86f1-41af-91ab-2d7cd011db47" }, "location": "West US", - "etag": "AAAAAAAAWiE=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Created", - "targetProvisioningState": "Activating", "createdAtUtc": "2019-04-11T16:29:29.9711098Z", + "enableClientCertificate": false, + "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": true + "negotiateClientCertificate": false } ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "mtv1", + "provisioningState": "Succeeded", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "", "virtualNetworkType": "None" }, "sku": { "name": "Consumption", "capacity": 0 }, - "identity": { - "type": "SystemAssigned", - "principalId": "dfb9a757-df69-4966-a8d0-711a9cd8ffb4", - "tenantId": "00000000-86f1-41af-91ab-2d7cd011db47" - }, "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", "createdBy": "string", "createdByType": "Application", - "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" + "etag": "AAAAAAAAWiE=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "SystemAssigned", + "principalId": "dfb9a757-df69-4966-a8d0-711a9cd8ffb4", + "tenantId": "00000000-86f1-41af-91ab-2d7cd011db47" }, "location": "West US", - "etag": "AAAAAAAAWiU=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", "createdAtUtc": "2019-04-11T16:29:29.9711098Z", - "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], - "virtualNetworkType": "None", - "enableClientCertificate": false, - "platformVersion": "mtv1" + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" }, "sku": { "name": "Consumption", "capacity": 0 }, - "identity": { - "type": "SystemAssigned", - "principalId": "dfb9a757-df69-4966-a8d0-711a9cd8ffb4", - "tenantId": "00000000-86f1-41af-91ab-2d7cd011db47" - }, "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", "createdBy": "string", "createdByType": "Application", - "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceHavingMsi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceInVnetWithPublicIP.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceInVnetWithPublicIP.json index 2597e5ce76a3..bbccc8055f62 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceInVnetWithPublicIP.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceInVnetWithPublicIP.json @@ -1,165 +1,167 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { + "location": "East US 2 EUAP", "properties": { + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet", "publisherEmail": "apim@autorestsdk.com", "publisherName": "autorestsdk", "virtualNetworkConfiguration": { "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant" }, - "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet", "virtualNetworkType": "External" }, "sku": { "name": "Premium", "capacity": 2 }, - "zones": [ - "1", - "2" - ], - "location": "East US 2 EUAP", "tags": { "tag1": "value1", "tag2": "value2", "tag3": "value3" - } - } + }, + "zones": [ + "1", + "2" + ] + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" - }, + "etag": "AAAAAAAGTAs=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.ApiManagement/service/apimService1", "location": "East US 2 EUAP", - "etag": "AAAAAAAiXto=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Created", - "targetProvisioningState": "Activating", - "createdAtUtc": "2020-07-28T23:18:14.6562474Z", + "createdAtUtc": "2021-02-22T06:53:46.6409875Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-eastus2euap-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "20.47.137.XXX" + ], "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", "virtualNetworkConfiguration": { "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant" }, - "virtualNetworkType": "External", - "disableGateway": false, - "platformVersion": "stv2.1" + "virtualNetworkType": "External" }, "sku": { "name": "Premium", "capacity": 2 }, - "zones": [ - "1", - "2" - ], "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", "createdBy": "string", "createdByType": "Application", - "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" - } - } - }, - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.ApiManagement/service/apimService1", - "name": "apimService1", - "type": "Microsoft.ApiManagement/service", + "lastModifiedByType": "Application" + }, "tags": { "tag1": "value1", "tag2": "value2", "tag3": "value3" }, + "zones": [ + "1", + "2" + ] + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAiXto=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "East US 2 EUAP", - "etag": "AAAAAAAGTAs=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2021-02-22T06:53:46.6409875Z", - "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-eastus2euap-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", + "createdAtUtc": "2020-07-28T23:18:14.6562474Z", + "disableGateway": false, "hostnameConfigurations": [ { "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": true + "negotiateClientCertificate": false } ], - "publicIPAddresses": [ - "20.47.137.XXX" - ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2.1", + "provisioningState": "Created", "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", "virtualNetworkConfiguration": { "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant" }, - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "External", - "disableGateway": false, - "platformVersion": "stv2" + "virtualNetworkType": "External" }, "sku": { "name": "Premium", "capacity": 2 }, - "zones": [ - "1", - "2" - ], "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", "createdBy": "string", "createdByType": "Application", - "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" - } + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "zones": [ + "1", + "2" + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceInVnetWithPublicIP" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceInZones.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceInZones.json index 3d28451ddba6..aea85144f27d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceInZones.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceInZones.json @@ -1,10 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { + "location": "North europe", "properties": { "publisherEmail": "apim@autorestsdk.com", "publisherName": "autorestsdk" @@ -13,140 +11,144 @@ "name": "Premium", "capacity": 2 }, - "zones": [ - "1", - "2" - ], - "location": "North europe", "tags": { "tag1": "value1", "tag2": "value2", "tag3": "value3" - } - } + }, + "zones": [ + "1", + "2" + ] + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" - }, + "etag": "AAAAAAAiXvE=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "North Europe", - "etag": "AAAAAAAiXto=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Created", - "targetProvisioningState": "Activating", "createdAtUtc": "2020-07-28T23:18:14.6562474Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], - "virtualNetworkType": "None", - "disableGateway": false, - "platformVersion": "stv2" + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "20.54.34.66" + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 2 }, - "zones": [ - "1", - "2" - ], "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", "createdBy": "string", "createdByType": "Application", - "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" - } - } - }, - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", - "name": "apimService1", - "type": "Microsoft.ApiManagement/service", + "lastModifiedByType": "Application" + }, "tags": { "tag1": "value1", "tag2": "value2", "tag3": "value3" }, + "zones": [ + "1", + "2" + ] + } + }, + "201": { + "body": { + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAiXto=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "North Europe", - "etag": "AAAAAAAiXvE=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", "createdAtUtc": "2020-07-28T23:18:14.6562474Z", - "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", + "disableGateway": false, "hostnameConfigurations": [ { "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": true + "negotiateClientCertificate": false } ], - "publicIPAddresses": [ - "20.54.34.66" - ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, - "platformVersion": "stv2" + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "provisioningState": "Created", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 2 }, - "zones": [ - "1", - "2" - ], "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", "createdBy": "string", "createdByType": "Application", - "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" - } + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "zones": [ + "1", + "2" + ] + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceInZones" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceSkuv2Service.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceSkuv2Service.json index d103192e4444..7cff8ac6e3a0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceSkuv2Service.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceSkuv2Service.json @@ -1,10 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "West US", "properties": { "publisherEmail": "apim@autorestsdk.com", "publisherName": "autorestsdk" @@ -13,141 +14,142 @@ "name": "StandardV2", "capacity": 1 }, - "identity": { - "type": "SystemAssigned" - }, - "location": "West US", "tags": { "tag1": "value1", "tag2": "value2", "tag3": "value3" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": {}, + "etag": "AAAAAAA3fHM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "SystemAssigned", + "principalId": "de161222-0000-0000-0000-1caa5d9f0b0e", + "tenantId": "72f988bf-0000-0000-0000-2d7cd011db47" + }, "location": "East US", - "etag": "AAAAAAA3h2Q=", "properties": { - "publisherEmail": "apim@contoso.com", - "publisherName": "apimgmt-skuv2", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Activating", - "targetProvisioningState": "Activating", - "createdAtUtc": "2023-08-11T18:24:14.7662749Z", + "createdAtUtc": "2023-08-10T18:50:52.5509471Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "disableGateway": false, "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, "natGatewayState": "Unsupported", - "publicNetworkAccess": "Enabled", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", "platformVersion": "undetermined", - "legacyPortalStatus": "Disabled", - "developerPortalStatus": "Disabled" + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "publisherEmail": "apim@contoso.com", + "publisherName": "apimgmt-skuv2", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "StandardV2", "capacity": 1 }, - "identity": { - "type": "SystemAssigned", - "principalId": "de161222-0000-0000-0000-1caa5d9f0b0e", - "tenantId": "72f988bf-0000-0000-0000-2d7cd011db47" - }, - "zones": null, "systemData": { + "createdAt": "2023-08-10T18:50:51.539583Z", "createdBy": "contoso@microsoft.com", "createdByType": "User", - "createdAt": "2023-08-11T18:24:13.7820033Z", + "lastModifiedAt": "2023-08-10T18:50:51.539583Z", "lastModifiedBy": "contoso@microsoft.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2023-08-11T18:24:13.7820033Z" - } + "lastModifiedByType": "User" + }, + "tags": {}, + "zones": null } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": {}, + "etag": "AAAAAAA3h2Q=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "SystemAssigned", + "principalId": "de161222-0000-0000-0000-1caa5d9f0b0e", + "tenantId": "72f988bf-0000-0000-0000-2d7cd011db47" + }, "location": "East US", - "etag": "AAAAAAA3fHM=", "properties": { - "publisherEmail": "apim@contoso.com", - "publisherName": "apimgmt-skuv2", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2023-08-10T18:50:52.5509471Z", + "createdAtUtc": "2023-08-11T18:24:14.7662749Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalStatus": "Disabled", + "disableGateway": false, "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, + "legacyPortalStatus": "Disabled", "natGatewayState": "Unsupported", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "undetermined", + "provisioningState": "Activating", "publicNetworkAccess": "Enabled", - "platformVersion": "undetermined" + "publisherEmail": "apim@contoso.com", + "publisherName": "apimgmt-skuv2", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" }, "sku": { "name": "StandardV2", "capacity": 1 }, - "identity": { - "type": "SystemAssigned", - "principalId": "de161222-0000-0000-0000-1caa5d9f0b0e", - "tenantId": "72f988bf-0000-0000-0000-2d7cd011db47" - }, - "zones": null, "systemData": { + "createdAt": "2023-08-11T18:24:13.7820033Z", "createdBy": "contoso@microsoft.com", "createdByType": "User", - "createdAt": "2023-08-10T18:50:51.539583Z", + "lastModifiedAt": "2023-08-11T18:24:13.7820033Z", "lastModifiedBy": "contoso@microsoft.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2023-08-10T18:50:51.539583Z" - } + "lastModifiedByType": "User" + }, + "tags": {}, + "zones": null + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceSkuv2Service" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithCustomHostnameKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithCustomHostnameKeyVault.json index 5f8ca0b060c5..562f35ba3277 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithCustomHostnameKeyVault.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithCustomHostnameKeyVault.json @@ -1,306 +1,308 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "North Europe", "properties": { + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, "hostnameConfigurations": [ { "type": "Proxy", + "defaultSslBinding": true, "hostName": "gateway1.msitesting.net", - "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", - "defaultSslBinding": true + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert" }, { "type": "Management", "hostName": "mgmt.msitesting.net", - "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", - "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468" + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert" }, { "type": "Portal", "hostName": "portal1.msitesting.net", - "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", - "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468" + "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert" }, { "type": "ConfigurationApi", - "hostName": "configuration-api.msitesting.net", + "certificatePassword": "Password", "encodedCertificate": "****** Base 64 Encoded Certificate ************", - "certificatePassword": "Password" + "hostName": "configuration-api.msitesting.net" } ], "publisherEmail": "apim@autorestsdk.com", "publisherName": "autorestsdk", - "virtualNetworkType": "None", - "apiVersionConstraint": { - "minApiVersion": "2019-01-01" - } + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 }, - "identity": { - "type": "UserAssigned", - "userAssignedIdentities": { - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} - } - }, - "location": "North Europe", "tags": { "tag1": "value1", "tag2": "value2", "tag3": "value3" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" + "etag": "AAAAAAAigjU=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "UserAssigned", + "tenantId": "f686d426-8d16-0000-0000-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "329419bc-adec-4dce-9568-25a6d486e468", + "principalId": "15e769b2-0000-0000-0000-3fd9a923ac3a" + } + } }, "location": "North Europe", - "etag": "AAAAAAAigi8=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Created", - "targetProvisioningState": "Activating", + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, "createdAtUtc": "2020-09-13T22:30:20.7759747Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": false, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false }, { "type": "Proxy", - "hostName": "gateway1.msitesting.net", - "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", - "negotiateClientCertificate": false, "certificate": { "expiry": "2037-01-01T07:00:00+00:00", - "thumbprint": "EA276907917CB5XXXXXXXXXXX690", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690" }, + "certificateSource": "KeyVault", "defaultSslBinding": true, + "hostName": "gateway1.msitesting.net", "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", - "certificateSource": "KeyVault" + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false }, { "type": "Management", - "hostName": "mgmt.msitesting.net", - "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", - "negotiateClientCertificate": false, "certificate": { "expiry": "2037-01-01T07:00:00+00:00", - "thumbprint": "EA276907917CB5XXXXXXXXXXX690", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690" }, + "certificateSource": "KeyVault", "defaultSslBinding": false, + "hostName": "mgmt.msitesting.net", "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", - "certificateSource": "KeyVault" + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false }, { "type": "Portal", - "hostName": "portal1.msitesting.net", - "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", - "negotiateClientCertificate": false, "certificate": { "expiry": "2037-01-01T07:00:00+00:00", - "thumbprint": "EA276907917CB5XXXXXXXXXXX690", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690" }, + "certificateSource": "KeyVault", "defaultSslBinding": false, + "hostName": "portal1.msitesting.net", "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", - "certificateSource": "KeyVault" + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false }, { "type": "ConfigurationApi", - "hostName": "configuration-api.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" }, - "defaultSslBinding": false + "defaultSslBinding": false, + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false } ], - "virtualNetworkType": "None", - "disableGateway": false, + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", "platformVersion": "stv2", - "apiVersionConstraint": { - "minApiVersion": "2019-01-01" - } + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "40.112.74.192" + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 }, - "identity": { - "type": "UserAssigned", - "userAssignedIdentities": { - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} - } - }, "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", "createdBy": "string", "createdByType": "Application", - "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" + "etag": "AAAAAAAigi8=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } }, "location": "North Europe", - "etag": "AAAAAAAigjU=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, "createdAtUtc": "2020-09-13T22:30:20.7759747Z", - "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", + "disableGateway": false, "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": false, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false }, { "type": "Proxy", - "hostName": "gateway1.msitesting.net", - "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", - "negotiateClientCertificate": false, "certificate": { "expiry": "2037-01-01T07:00:00+00:00", - "thumbprint": "EA276907917CB5XXXXXXXXXXX690", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690" }, + "certificateSource": "KeyVault", "defaultSslBinding": true, + "hostName": "gateway1.msitesting.net", "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", - "certificateSource": "KeyVault" + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false }, { "type": "Management", - "hostName": "mgmt.msitesting.net", - "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", - "negotiateClientCertificate": false, "certificate": { "expiry": "2037-01-01T07:00:00+00:00", - "thumbprint": "EA276907917CB5XXXXXXXXXXX690", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690" }, + "certificateSource": "KeyVault", "defaultSslBinding": false, + "hostName": "mgmt.msitesting.net", "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", - "certificateSource": "KeyVault" + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false }, { "type": "Portal", - "hostName": "portal1.msitesting.net", - "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", - "negotiateClientCertificate": false, "certificate": { "expiry": "2037-01-01T07:00:00+00:00", - "thumbprint": "EA276907917CB5XXXXXXXXXXX690", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "EA276907917CB5XXXXXXXXXXX690" }, + "certificateSource": "KeyVault", "defaultSslBinding": false, + "hostName": "portal1.msitesting.net", "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468", - "certificateSource": "KeyVault" + "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false }, { "type": "ConfigurationApi", - "hostName": "configuration-api.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" }, - "defaultSslBinding": false + "defaultSslBinding": false, + "hostName": "configuration-api.msitesting.net", + "negotiateClientCertificate": false } ], - "publicIPAddresses": [ - "40.112.74.192" - ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", "platformVersion": "stv2", - "apiVersionConstraint": { - "minApiVersion": "2019-01-01" - } + "provisioningState": "Created", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 }, - "identity": { - "type": "UserAssigned", - "tenantId": "f686d426-8d16-0000-0000-ab578e110ccd", - "userAssignedIdentities": { - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { - "principalId": "15e769b2-0000-0000-0000-3fd9a923ac3a", - "clientId": "329419bc-adec-4dce-9568-25a6d486e468" - } - } - }, "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", "createdBy": "string", "createdByType": "Application", - "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceWithCustomHostnameKeyVault" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithDeveloperPortal.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithDeveloperPortal.json index a9806719a66a..3cb2b58e0801 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithDeveloperPortal.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithDeveloperPortal.json @@ -1,142 +1,144 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { + "location": "South Central US", "properties": { + "developerPortalStatus": "Enabled", "publisherEmail": "foo@contoso.com", - "publisherName": "foo", - "developerPortalStatus": "Enabled" + "publisherName": "foo" }, "sku": { "name": "Developer", "capacity": 1 }, - "location": "South Central US", "tags": { "Name": "Contoso", "Test": "User" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "api-version": "2024-10-01-preview" - }, + "etag": "AAAAAAAmREI=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "East US", - "etag": "AAAAAAAmRAM=", "properties": { - "publisherEmail": "samir@microsoft.com", - "publisherName": "foo", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Created", - "targetProvisioningState": "Activating", "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], - "virtualNetworkType": "None", - "disableGateway": false, + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv1", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.90.229.33" + ], "publicNetworkAccess": "Enabled", - "platformVersion": "undetermined", - "legacyPortalStatus": "Disabled", - "developerPortalStatus": "Enabled" + "publisherEmail": "samir@microsoft.com", + "publisherName": "foo", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Standard", "capacity": 1 }, "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", "createdBy": "user@contoso.com", "createdByType": "User", - "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", "lastModifiedBy": "user@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "api-version": "2024-10-01-preview" - }, + "etag": "AAAAAAAmRAM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "East US", - "etag": "AAAAAAAmREI=", "properties": { - "publisherEmail": "samir@microsoft.com", - "publisherName": "foo", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "developerPortalStatus": "Enabled", + "disableGateway": false, "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], - "publicIPAddresses": [ - "13.90.229.33" - ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, + "legacyPortalStatus": "Disabled", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "undetermined", + "provisioningState": "Created", "publicNetworkAccess": "Enabled", - "platformVersion": "stv1" + "publisherEmail": "samir@microsoft.com", + "publisherName": "foo", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" }, "sku": { "name": "Standard", "capacity": 1 }, "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", "createdBy": "user@contoso.com", "createdByType": "User", - "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", "lastModifiedBy": "user@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceWithDeveloperPortal" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithNatGatewayEnabled.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithNatGatewayEnabled.json index 367c97c552c9..a05e6ad1b200 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithNatGatewayEnabled.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithNatGatewayEnabled.json @@ -1,160 +1,162 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { + "location": "East US", "properties": { + "natGatewayState": "Enabled", "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "natGatewayState": "Enabled" + "publisherName": "autorestsdk" }, "sku": { "name": "Premium", "capacity": 1 }, - "location": "East US", "tags": { "tag1": "value1", "tag2": "value2", "tag3": "value3" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "api-version": "2024-10-01-preview" - }, + "etag": "AAAAAAAmREI=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "East US", - "etag": "AAAAAAAmRAM=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Created", - "targetProvisioningState": "Activating", - "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "apiVersionConstraint": { + "minApiVersion": null + }, + "createdAtUtc": "2022-07-26T18:41:01.2506031Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], - "privateIPAddresses": null, - "additionalLocations": null, - "virtualNetworkConfiguration": null, - "virtualNetworkType": "None", - "certificates": null, - "disableGateway": false, + "managementApiUrl": "https://apimService1.management.azure-api.net", "natGatewayState": "Enabled", - "apiVersionConstraint": { - "minApiVersion": null - }, - "publicIpAddressId": null, + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "outboundPublicIPAddresses": [ + "60.0.0.0/31" + ], + "platformVersion": "stv2", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.90.229.33" + ], "publicNetworkAccess": "Enabled", - "privateEndpointConnections": null, - "platformVersion": "stv2" + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 }, - "identity": null, - "zones": null, "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", "createdBy": "user@contoso.com", "createdByType": "User", - "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", "lastModifiedBy": "user@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "api-version": "2024-10-01-preview" - }, + "etag": "AAAAAAAmRAM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": null, "location": "East US", - "etag": "AAAAAAAmREI=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2022-07-26T18:41:01.2506031Z", + "additionalLocations": null, + "apiVersionConstraint": { + "minApiVersion": null + }, + "certificates": null, + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "disableGateway": false, "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], - "publicIPAddresses": [ - "13.90.229.33" - ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false" - }, - "virtualNetworkType": "None", - "disableGateway": false, "natGatewayState": "Enabled", - "outboundPublicIPAddresses": [ - "60.0.0.0/31" - ], - "apiVersionConstraint": { - "minApiVersion": null - }, + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "privateEndpointConnections": null, + "privateIPAddresses": null, + "provisioningState": "Created", + "publicIpAddressId": null, "publicNetworkAccess": "Enabled", - "platformVersion": "stv2" + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkConfiguration": null, + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 }, "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", "createdBy": "user@contoso.com", "createdByType": "User", - "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", "lastModifiedBy": "user@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" - } + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" + }, + "zones": null + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceWithNatGatewayEnabled" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithSystemCertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithSystemCertificates.json index fecadce67ec3..edfa70df9ef9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithSystemCertificates.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithSystemCertificates.json @@ -1,15 +1,13 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { + "location": "Central US", "properties": { "certificates": [ { - "encodedCertificate": "*******Base64 encoded Certificate******************", "certificatePassword": "Password", + "encodedCertificate": "*******Base64 encoded Certificate******************", "storeName": "CertificateAuthority" } ], @@ -20,150 +18,154 @@ "name": "Basic", "capacity": 1 }, - "location": "Central US", "tags": { "tag1": "value1", "tag2": "value2", "tag3": "value3" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" - }, + "etag": "AAAAAAAp3UM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "Central US", - "etag": "AAAAAAAp3TM=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Created", - "targetProvisioningState": "Activating", - "createdAtUtc": "2019-12-18T06:33:28.0906918Z", - "hostnameConfigurations": [ - { - "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": true - } - ], - "virtualNetworkType": "None", + "apiVersionConstraint": {}, "certificates": [ { - "storeName": "CertificateAuthority", "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2", - "subject": "CN=*.msitesting.net" - } + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2" + }, + "storeName": "CertificateAuthority" } ], + "createdAtUtc": "2019-12-18T06:33:28.0906918Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-centralus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", "platformVersion": "stv2", - "apiVersionConstraint": {} + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "40.113.223.117" + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Basic", "capacity": 1 }, "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", "createdBy": "string", "createdByType": "Application", - "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" - }, + "etag": "AAAAAAAp3TM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "Central US", - "etag": "AAAAAAAp3UM=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2019-12-18T06:33:28.0906918Z", - "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-centralus-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", - "hostnameConfigurations": [ - { - "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": true, - "certificateSource": "BuiltIn" - } - ], - "publicIPAddresses": [ - "40.113.223.117" - ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", + "apiVersionConstraint": {}, "certificates": [ { - "storeName": "CertificateAuthority", "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2", - "subject": "CN=*.msitesting.net" - } + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2" + }, + "storeName": "CertificateAuthority" } ], + "createdAtUtc": "2019-12-18T06:33:28.0906918Z", "disableGateway": false, + "hostnameConfigurations": [ + { + "type": "Proxy", + "defaultSslBinding": true, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + } + ], + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", "platformVersion": "stv2", - "apiVersionConstraint": {} + "provisioningState": "Created", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" }, "sku": { "name": "Basic", "capacity": 1 }, "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", "createdBy": "string", "createdByType": "Application", - "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceWithSystemCertificates" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithUserAssignedIdentity.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithUserAssignedIdentity.json index a3699de38d29..086a15c3f4ca 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithUserAssignedIdentity.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithUserAssignedIdentity.json @@ -1,10 +1,14 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {} + } + }, + "location": "West US", "properties": { "publisherEmail": "apim@autorestsdk.com", "publisherName": "autorestsdk" @@ -13,140 +17,138 @@ "name": "Consumption", "capacity": 0 }, - "identity": { - "type": "UserAssigned", - "userAssignedIdentities": { - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {} - } - }, - "location": "West US", "tags": { "tag1": "value1", "tag2": "value2", "tag3": "value3" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" + "etag": "AAAAAAAFzyk=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "UserAssigned", + "tenantId": "00000000-86f1-41af-0000-2d7cd011db47", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": { + "clientId": "5a2c6b8e-0905-0000-a772-993c9418137f", + "principalId": "00000000-6e62-4649-9f54-a119fc1ba85e" + } + } }, "location": "West US", - "etag": "AAAAAAAFzyQ=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Created", - "targetProvisioningState": "Activating", "createdAtUtc": "2020-03-12T01:05:33.4573398Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "disableGateway": false, + "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], - "virtualNetworkType": "None", - "platformVersion": "mtv1" + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "mtv1", + "provisioningState": "Succeeded", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Consumption", "capacity": 0 }, - "identity": { - "type": "UserAssigned", - "userAssignedIdentities": { - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {} - } - }, "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", "createdBy": "string", "createdByType": "Application", - "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" + "etag": "AAAAAAAFzyQ=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {} + } }, "location": "West US", - "etag": "AAAAAAAFzyk=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", "createdAtUtc": "2020-03-12T01:05:33.4573398Z", - "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, - "platformVersion": "mtv1" + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "mtv1", + "provisioningState": "Created", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" }, "sku": { "name": "Consumption", "capacity": 0 }, - "identity": { - "type": "UserAssigned", - "tenantId": "00000000-86f1-41af-0000-2d7cd011db47", - "userAssignedIdentities": { - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": { - "principalId": "00000000-6e62-4649-9f54-a119fc1ba85e", - "clientId": "5a2c6b8e-0905-0000-a772-993c9418137f" - } - } - }, "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", "createdBy": "string", "createdByType": "Application", - "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceWithUserAssignedIdentity" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithoutLegacyConfigurationApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithoutLegacyConfigurationApi.json index e20d5ee041cd..8f3da7a68d7d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithoutLegacyConfigurationApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateServiceWithoutLegacyConfigurationApi.json @@ -1,153 +1,155 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { + "location": "Central US", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", "configurationApi": { "legacyApi": "Disabled" - } + }, + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk" }, "sku": { "name": "Basic", "capacity": 1 }, - "location": "Central US", "tags": { "tag1": "value1", "tag2": "value2", "tag3": "value3" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" - }, + "etag": "AAAAAAAp3UM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "Central US", - "etag": "AAAAAAAp3TM=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Created", - "targetProvisioningState": "Activating", + "apiVersionConstraint": {}, + "certificates": [], + "configurationApi": { + "legacyApi": "Disabled" + }, "createdAtUtc": "2019-12-18T06:33:28.0906918Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-centralus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": true + "negotiateClientCertificate": false } ], - "virtualNetworkType": "None", - "certificates": [], - "disableGateway": false, - "configurationApi": { - "legacyApi": "Disabled" - }, + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", "platformVersion": "stv2", - "apiVersionConstraint": {} + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "40.113.223.117" + ], + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Basic", "capacity": 1 }, "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", "createdBy": "string", "createdByType": "Application", - "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" - }, + "etag": "AAAAAAAp3TM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "Central US", - "etag": "AAAAAAAp3UM=", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", + "apiVersionConstraint": {}, + "certificates": [], + "configurationApi": { + "legacyApi": "Disabled" + }, "createdAtUtc": "2019-12-18T06:33:28.0906918Z", - "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-centralus-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", + "disableGateway": false, "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false } ], - "publicIPAddresses": [ - "40.113.223.117" - ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "certificates": [], - "disableGateway": false, - "configurationApi": { - "legacyApi": "Disabled" - }, + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", "platformVersion": "stv2", - "apiVersionConstraint": {} + "provisioningState": "Created", + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" }, "sku": { "name": "Basic", "capacity": 1 }, "systemData": { + "createdAt": "2020-02-01T01:01:01.1075056Z", "createdBy": "string", "createdByType": "Application", - "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z", "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + "lastModifiedByType": "Application" + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementCreateServiceWithoutLegacyConfigurationApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json index 6b9bd628629a..198253ea37f0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json @@ -1,77 +1,79 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "soapApi", "parameters": { "properties": { "format": "wsdl-link", - "value": "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL", "path": "currency", "apiType": "soap", + "value": "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL", "wsdlSelector": { - "wsdlServiceName": "CurrencyConvertor", - "wsdlEndpointName": "CurrencyConvertorSoap" + "wsdlEndpointName": "CurrencyConvertorSoap", + "wsdlServiceName": "CurrencyConvertor" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", - "type": "Microsoft.ApiManagement/service/apis", "name": "soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", "properties": { - "displayName": "CurrencyConvertor", - "apiRevision": "1", - "serviceUrl": "http://www.webservicex.net", + "type": "soap", "path": "currency", + "apiRevision": "1", + "displayName": "CurrencyConvertor", + "isCurrent": true, "protocols": [ "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://www.webservicex.net", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "type": "soap", - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", - "type": "Microsoft.ApiManagement/service/apis", "name": "soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", "properties": { - "displayName": "CurrencyConvertor", - "apiRevision": "1", - "serviceUrl": "http://www.webservicex.net", + "type": "soap", "path": "currency", + "apiRevision": "1", + "displayName": "CurrencyConvertor", + "isCurrent": true, "protocols": [ "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://www.webservicex.net", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "type": "soap", - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateSoapPassThroughApiUsingWsdlImport" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json index 405dd6988e1b..1b01e15384e8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json @@ -1,74 +1,76 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "soapApi", "parameters": { "properties": { "format": "wsdl-link", - "value": "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL", "path": "currency", + "value": "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL", "wsdlSelector": { - "wsdlServiceName": "CurrencyConvertor", - "wsdlEndpointName": "CurrencyConvertorSoap" + "wsdlEndpointName": "CurrencyConvertorSoap", + "wsdlServiceName": "CurrencyConvertor" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", - "type": "Microsoft.ApiManagement/service/apis", "name": "soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", "properties": { - "displayName": "CurrencyConvertor", - "apiRevision": "1", - "serviceUrl": "http://www.webservicex.net", "path": "currency", + "apiRevision": "1", + "displayName": "CurrencyConvertor", + "isCurrent": true, "protocols": [ "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://www.webservicex.net", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", - "type": "Microsoft.ApiManagement/service/apis", "name": "soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", "properties": { - "displayName": "CurrencyConvertor", - "apiRevision": "1", - "serviceUrl": "http://www.webservicex.net", "path": "currency", + "apiRevision": "1", + "displayName": "CurrencyConvertor", + "isCurrent": true, "protocols": [ "https" ], + "provisioningState": "InProgress", + "serviceUrl": "http://www.webservicex.net", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateSoapToRestApiUsingWsdlImport" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateStandardGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateStandardGateway.json index 4dcb9d028434..2fc2feb5e9f4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateStandardGateway.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateStandardGateway.json @@ -1,10 +1,9 @@ { "parameters": { - "gatewayName": "apimGateway1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayName": "apimGateway1", "parameters": { + "location": "South Central US", "properties": { "backend": { "subnet": { @@ -16,91 +15,94 @@ "name": "Standard", "capacity": 1 }, - "location": "South Central US", "tags": { "Name": "Contoso", "Test": "User" } - } + }, + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", "name": "apimGateway1", - "type": "Microsoft.ApiManagement/gateway", - "tags": { - "api-version": "2024-10-01-preview" - }, + "type": "Microsoft.ApiManagement/gateways", + "etag": "AAAAAAAmREI=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", "location": "East US", - "etag": "AAAAAAAmRAM=", "properties": { - "provisioningState": "Created", - "targetProvisioningState": "Activating", - "createdAtUtc": "2022-07-11T18:41:01.2506031Z", "backend": { "subnet": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" } - } + }, + "configurationApi": { + "hostname": "apimGateway1.eastus.configuration.gateway.azure-api.net" + }, + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "frontend": { + "defaultHostname": "apimGateway1.eastus.gateway.azure-api.net" + }, + "provisioningState": "Succeeded", + "targetProvisioningState": "" }, "sku": { "name": "Standard", "capacity": 1 }, "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", "createdBy": "user@contoso.com", "createdByType": "User", - "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", "lastModifiedBy": "user@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", "name": "apimGateway1", - "type": "Microsoft.ApiManagement/gateways", - "tags": { - "api-version": "2024-10-01-preview" - }, + "type": "Microsoft.ApiManagement/gateway", + "etag": "AAAAAAAmRAM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", "location": "East US", - "etag": "AAAAAAAmREI=", "properties": { - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2022-07-11T18:41:01.2506031Z", - "frontend": { - "defaultHostname": "apimGateway1.eastus.gateway.azure-api.net" - }, "backend": { "subnet": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" } }, - "configurationApi": { - "hostname": "apimGateway1.eastus.configuration.gateway.azure-api.net" - } + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "provisioningState": "Created", + "targetProvisioningState": "Activating" }, "sku": { "name": "Standard", "capacity": 1 }, "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", "createdBy": "user@contoso.com", "createdByType": "User", - "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", "lastModifiedBy": "user@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiGateway_CreateOrUpdate", + "title": "ApiManagementCreateStandardGateway" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateSubscription.json index 222664f42add..6af4c94cc49f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateSubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateSubscription.json @@ -1,46 +1,48 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "sid": "testsub", "parameters": { "properties": { + "displayName": "testsub", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", - "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", - "displayName": "testsub" + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub", - "type": "Microsoft.ApiManagement/service/subscriptions", "name": "testsub", + "type": "Microsoft.ApiManagement/service/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub", "properties": { + "createdDate": "2017-06-02T23:34:03.1055076Z", + "displayName": "testsub", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", - "displayName": "testsub", - "state": "submitted", - "createdDate": "2017-06-02T23:34:03.1055076Z" + "state": "submitted" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub", - "type": "Microsoft.ApiManagement/service/subscriptions", "name": "testsub", + "type": "Microsoft.ApiManagement/service/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub", "properties": { + "createdDate": "2017-06-02T23:34:03.1055076Z", + "displayName": "testsub", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", - "displayName": "testsub", - "state": "submitted", - "createdDate": "2017-06-02T23:34:03.1055076Z" + "state": "submitted" } } } - } + }, + "operationId": "Subscription_CreateOrUpdate", + "title": "ApiManagementCreateSubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTag.json index 78dc36bb03e7..f7efd69b5d4a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTag.json @@ -1,36 +1,38 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "tagId": "tagId1", "parameters": { "properties": { "displayName": "tag1" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tagId1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", - "type": "Microsoft.ApiManagement/service/tags", "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", "properties": { "displayName": "tag1" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", - "type": "Microsoft.ApiManagement/service/tags", "name": "tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", "properties": { "displayName": "tag1" } } } - } + }, + "operationId": "Tag_CreateOrUpdate", + "title": "ApiManagementCreateTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTagApiLink.json index 676c27c521f6..a3c5cdd162e2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTagApiLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTagApiLink.json @@ -1,37 +1,39 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "tagId": "tag1", "apiLinkId": "link1", "parameters": { "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/tags/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/tags/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" } } } - } + }, + "operationId": "TagApiLink_CreateOrUpdate", + "title": "ApiManagementCreateTagApiLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTagOperationLink.json index 027e928c169e..0616c0abec47 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTagOperationLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTagOperationLink.json @@ -1,37 +1,39 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "tagId": "tag1", "operationLinkId": "link1", "parameters": { "properties": { "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", - "type": "Microsoft.ApiManagement/service/tags/operationLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", "properties": { "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", - "type": "Microsoft.ApiManagement/service/tags/operationLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", "properties": { "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" } } } - } + }, + "operationId": "TagOperationLink_CreateOrUpdate", + "title": "ApiManagementCreateTagOperationLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTagProductLink.json index 8f0784d73fac..82597fee7939 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTagProductLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTagProductLink.json @@ -1,37 +1,39 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "tagId": "tag1", - "productLinkId": "link1", "parameters": { "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" } - } + }, + "productLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", - "type": "Microsoft.ApiManagement/service/tags/productLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", - "type": "Microsoft.ApiManagement/service/tags/productLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" } } } - } + }, + "operationId": "TagProductLink_CreateOrUpdate", + "title": "ApiManagementCreateTagProductLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTemplate.json index 57650db6b37a..77f4cbc28044 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTemplate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTemplate.json @@ -1,27 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "templateName": "newIssueNotificationMessage", "parameters": { "properties": { "subject": "Your request for $IssueName was successfully received." } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "templateName": "newIssueNotificationMessage" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", - "type": "Microsoft.ApiManagement/service/templates", "name": "NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", "properties": { - "subject": "Your request for $IssueName was successfully received.", - "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", - "title": "New issue received", "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", "isDefault": false, "parameters": [ { @@ -48,20 +46,20 @@ "name": "DevPortalUrl", "title": "Developer portal URL" } - ] + ], + "subject": "Your request for $IssueName was successfully received.", + "title": "New issue received" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", - "type": "Microsoft.ApiManagement/service/templates", "name": "NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", "properties": { - "subject": "Your request for $IssueName was successfully received.", - "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", - "title": "New issue received", "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", "isDefault": false, "parameters": [ { @@ -88,9 +86,13 @@ "name": "DevPortalUrl", "title": "Developer portal URL" } - ] + ], + "subject": "Your request for $IssueName was successfully received.", + "title": "New issue received" } } } - } + }, + "operationId": "EmailTemplate_CreateOrUpdate", + "title": "ApiManagementCreateTemplate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTenantAccess.json index ca8522e91f52..d1f8d79332cd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTenantAccess.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateTenantAccess.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "If-Match": "*", "accessName": "access", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "enabled": true } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", - "type": "Microsoft.ApiManagement/service/tenant", "name": "access", + "type": "Microsoft.ApiManagement/service/tenant", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", "properties": { "enabled": true } } } - } + }, + "operationId": "TenantAccess_Create", + "title": "ApiManagementCreateTenantAccess" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateUser.json index 84201c8799b9..b99b2ac6d668 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateUser.json @@ -1,61 +1,63 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userId": "5931a75ae4bbd512288c680b", "parameters": { "properties": { - "firstName": "foo", - "lastName": "bar", + "confirmation": "signup", "email": "foobar@outlook.com", - "confirmation": "signup" + "firstName": "foo", + "lastName": "bar" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b", - "type": "Microsoft.ApiManagement/service/users", "name": "5931a75ae4bbd512288c680b", + "type": "Microsoft.ApiManagement/service/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b", "properties": { - "firstName": "foo", - "lastName": "bar", "email": "foobar@outlook.com", - "state": "active", - "registrationDate": "2018-01-07T21:21:29.16Z", + "firstName": "foo", "groups": [], "identities": [ { - "provider": "Basic", - "id": "foobar@outlook.com" + "id": "foobar@outlook.com", + "provider": "Basic" } - ] + ], + "lastName": "bar", + "registrationDate": "2018-01-07T21:21:29.16Z", + "state": "active" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b", - "type": "Microsoft.ApiManagement/service/users", "name": "5931a75ae4bbd512288c680b", + "type": "Microsoft.ApiManagement/service/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b", "properties": { - "firstName": "foo", - "lastName": "bar", "email": "foobar@outlook.com", - "state": "active", - "registrationDate": "2018-01-07T21:21:29.16Z", + "firstName": "foo", "groups": [], "identities": [ { - "provider": "Basic", - "id": "foobar@outlook.com" + "id": "foobar@outlook.com", + "provider": "Basic" } - ] + ], + "lastName": "bar", + "registrationDate": "2018-01-07T21:21:29.16Z", + "state": "active" } } } - } + }, + "operationId": "User_CreateOrUpdate", + "title": "ApiManagementCreateUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWebsocketApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWebsocketApi.json index 302fda6f168a..0b9b1c67efb4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWebsocketApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWebsocketApi.json @@ -1,80 +1,82 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "tempgroup", "parameters": { "properties": { - "description": "apidescription5200", - "displayName": "apiname1463", "type": "websocket", - "serviceUrl": "wss://echo.websocket.org", "path": "newapiPath", + "description": "apidescription5200", + "displayName": "apiname1463", "protocols": [ "wss", "ws" - ] + ], + "serviceUrl": "wss://echo.websocket.org" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/apis", "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "wss://echo.websocket.org", "type": "websocket", "path": "newapiPath", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": null, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, "protocols": [ "ws", "wss" ], - "authenticationSettings": null, - "subscriptionKeyParameterNames": null, - "isCurrent": true, - "isOnline": true, - "provisioningState": "InProgress" + "provisioningState": "InProgress", + "serviceUrl": "wss://echo.websocket.org", + "subscriptionKeyParameterNames": null } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/apis", "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "wss://echo.websocket.org", "type": "websocket", "path": "newapiPath", + "description": "apidescription5200", + "apiRevision": "1", + "authenticationSettings": null, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, "protocols": [ "ws", "wss" ], - "authenticationSettings": null, - "subscriptionKeyParameterNames": null, - "isCurrent": true, - "isOnline": true, - "provisioningState": "InProgress" + "provisioningState": "InProgress", + "serviceUrl": "wss://echo.websocket.org", + "subscriptionKeyParameterNames": null } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "Api_CreateOrUpdate", + "title": "ApiManagementCreateWebSocketApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspace.json index 0aaeb47aeff0..dfc243a36f3b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspace.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspace.json @@ -1,39 +1,41 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "parameters": { "properties": { - "displayName": "my workspace", - "description": "workspace 1" + "description": "workspace 1", + "displayName": "my workspace" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", - "type": "Microsoft.ApiManagement/service/workspaces", "name": "wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", "properties": { "description": "workspace 1", "displayName": "my workspace" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", - "type": "Microsoft.ApiManagement/service/workspaces", "name": "wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", "properties": { "description": "workspace 1", "displayName": "my workspace" } } } - } + }, + "operationId": "Workspace_CreateOrUpdate", + "title": "ApiManagementCreateWorkspace" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceAILogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceAILogger.json index dc50939a9b88..679941702ed7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceAILogger.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceAILogger.json @@ -1,52 +1,54 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "loggerId": "loggerId", "parameters": { "properties": { - "loggerType": "applicationInsights", "description": "adding a new logger", "credentials": { "instrumentationKey": "11................a1" - } + }, + "loggerType": "applicationInsights" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/loggerId", - "type": "Microsoft.ApiManagement/service/workspaces/loggers", "name": "loggerId", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/loggerId", "properties": { - "loggerType": "applicationInsights", "description": null, "credentials": { "instrumentationKey": "{{5a.......2a}}" }, "isBuffered": false, - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.insights/components/airesource" + "loggerType": "applicationInsights" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/loggerId", - "type": "Microsoft.ApiManagement/service/workspaces/loggers", "name": "loggerId", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/loggerId", "properties": { - "loggerType": "applicationInsights", "description": null, "credentials": { "instrumentationKey": "{{5a.......2a}}" }, - "isBuffered": false + "isBuffered": false, + "loggerType": "applicationInsights", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.insights/components/airesource" } } } - } + }, + "operationId": "WorkspaceLogger_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceAILogger" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApi.json index 58dfc3bee419..42aa3163efe0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApi.json @@ -1,13 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "tempgroup", "parameters": { "properties": { + "path": "newapiPath", "description": "apidescription5200", "authenticationSettings": { "oAuth2": { @@ -15,40 +12,33 @@ "scope": "oauth2scope2580" } }, - "subscriptionKeyParameterNames": { - "header": "header4520", - "query": "query3037" - }, "displayName": "apiname1463", - "serviceUrl": "http://newechoapi.cloudapp.net/api", - "path": "newapiPath", "protocols": [ "https", "http" - ] + ], + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/workspaces/apis", "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/apiid9419", "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "http://newechoapi.cloudapp.net/api", "path": "newapiPath", - "protocols": [ - "http", - "https" - ], + "description": "apidescription5200", + "apiRevision": "1", "authenticationSettings": { "oAuth2": { "authorizationServerId": "authorizationServerId2283", @@ -61,35 +51,35 @@ } ] }, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", "subscriptionKeyParameterNames": { "header": "header4520", "query": "query3037" - }, - "isCurrent": true, - "isOnline": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/apiid9419", - "type": "Microsoft.ApiManagement/service/workspaces/apis", "name": "apiid9419", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/apiid9419", "properties": { - "displayName": "apiname1463", - "apiRevision": "1", - "description": "apidescription5200", - "serviceUrl": "http://newechoapi.cloudapp.net/api", "path": "newapiPath", - "protocols": [ - "http", - "https" - ], + "description": "apidescription5200", + "apiRevision": "1", "authenticationSettings": { "oAuth2": { "authorizationServerId": "authorizationServerId2283", @@ -102,15 +92,27 @@ } ] }, + "displayName": "apiname1463", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "http", + "https" + ], + "provisioningState": "InProgress", + "serviceUrl": "http://newechoapi.cloudapp.net/api", "subscriptionKeyParameterNames": { "header": "header4520", "query": "query3037" - }, - "isCurrent": true, - "isOnline": true, - "provisioningState": "InProgress" + } } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "WorkspaceApi_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiDiagnostic.json index 8c9745c0f8f0..19d668b46900 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiDiagnostic.json @@ -1,161 +1,163 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "diagnosticId": "applicationinsights", "apiId": "57d1f7558aa04f15146d9d8a", + "diagnosticId": "applicationinsights", "parameters": { "properties": { "alwaysLog": "allErrors", - "loggerId": "/workspaces/wks1/loggers/applicationinsights", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "loggerId": "/workspaces/wks1/loggers/applicationinsights", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "loggerId": "/workspaces/wks1/loggers/applicationinsights", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } } } - } + }, + "operationId": "WorkspaceApiDiagnostic_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApiDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiOperation.json index 9a6a8996837c..b21e49aa9a7d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiOperation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiOperation.json @@ -1,23 +1,19 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "newoperations", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "PetStoreTemplate2", - "operationId": "newoperations", "parameters": { "properties": { - "displayName": "createUser2", "method": "POST", - "urlTemplate": "/user1", - "templateParameters": [], "description": "This can only be done by the logged in user.", + "displayName": "createUser2", + "templateParameters": [], + "urlTemplate": "/user1", "request": { "description": "Created user object", - "queryParameters": [], "headers": [], + "queryParameters": [], "representations": [ { "contentType": "application/json", @@ -28,8 +24,8 @@ }, "responses": [ { - "statusCode": 200, "description": "successful operation", + "headers": [], "representations": [ { "contentType": "application/xml" @@ -38,28 +34,32 @@ "contentType": "application/json" } ], - "headers": [] + "statusCode": 200 } ] } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/PetStoreTemplate2/operations/newoperations", - "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", "name": "newoperations", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/PetStoreTemplate2/operations/newoperations", "properties": { - "displayName": "createUser2", "method": "POST", - "urlTemplate": "/user1", - "templateParameters": [], "description": "This can only be done by the logged in user.", + "displayName": "createUser2", + "templateParameters": [], + "urlTemplate": "/user1", "request": { "description": "Created user object", - "queryParameters": [], "headers": [], + "queryParameters": [], "representations": [ { "contentType": "application/json", @@ -70,8 +70,8 @@ }, "responses": [ { - "statusCode": 200, "description": "successful operation", + "headers": [], "representations": [ { "contentType": "application/xml" @@ -80,27 +80,27 @@ "contentType": "application/json" } ], - "headers": [] + "statusCode": 200 } ] } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/PetStoreTemplate2/operations/newoperations", - "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", "name": "newoperations", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/PetStoreTemplate2/operations/newoperations", "properties": { - "displayName": "createUser2", "method": "POST", - "urlTemplate": "/user1", - "templateParameters": [], "description": "This can only be done by the logged in user.", + "displayName": "createUser2", + "templateParameters": [], + "urlTemplate": "/user1", "request": { "description": "Created user object", - "queryParameters": [], "headers": [], + "queryParameters": [], "representations": [ { "contentType": "application/json", @@ -111,8 +111,8 @@ }, "responses": [ { - "statusCode": 200, "description": "successful operation", + "headers": [], "representations": [ { "contentType": "application/xml" @@ -121,11 +121,13 @@ "contentType": "application/json" } ], - "headers": [] + "statusCode": 200 } ] } } } - } + }, + "operationId": "WorkspaceApiOperation_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApiOperation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiOperationPolicy.json index ee20c54343a1..ada756ba9a62 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiOperationPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiOperationPolicy.json @@ -1,41 +1,43 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "apiId": "5600b57e7e8880006a040001", "operationId": "5600b57e7e8880006a080001", - "policyId": "policy", "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "5600b57e7e8880006a040001", "parameters": { "properties": { "format": "xml", "value": " " } - } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "WorkspaceApiOperationPolicy_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApiOperationPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiPolicy.json index 758262d86b7e..329d6ccef84c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiPolicy.json @@ -1,40 +1,42 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "5600b57e7e8880006a040001", - "policyId": "policy", - "If-Match": "*", "parameters": { "properties": { "format": "xml", "value": " " } - } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b57e7e8880006a040001/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "WorkspaceApiPolicy_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApiPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiRelease.json index 52d6f0270ec0..70e353a18d81 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiRelease.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiRelease.json @@ -1,45 +1,47 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "a1", - "releaseId": "testrev", "parameters": { "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", "notes": "yahooagain" } - } + }, + "releaseId": "testrev", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/testrev", - "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", "name": "testrev", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/testrev", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", "createdDateTime": "2018-02-08T20:52:00.65Z", - "updatedDateTime": "2018-02-08T20:52:00.65Z", - "notes": "yahooagain" + "notes": "yahooagain", + "updatedDateTime": "2018-02-08T20:52:00.65Z" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/testrev", - "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", "name": "testrev", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/testrev", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", "createdDateTime": "2018-02-08T20:52:00.65Z", - "updatedDateTime": "2018-02-08T20:52:00.65Z", - "notes": "yahooagain" + "notes": "yahooagain", + "updatedDateTime": "2018-02-08T20:52:00.65Z" } } } - } + }, + "operationId": "WorkspaceApiRelease_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApiRelease" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiSchema.json index d32f1b8cdc12..cedc322d08f7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiSchema.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiSchema.json @@ -1,12 +1,7 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "59d6bb8f1f7fab13dc67ec9b", - "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", "parameters": { "properties": { "contentType": "application/vnd.ms-azure-apim.xsd+xml", @@ -14,18 +9,19 @@ "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } } - } + }, + "resourceGroupName": "rg1", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", - "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", "properties": { "contentType": "application/vnd.ms-azure-apim.xsd+xml", "document": { @@ -33,17 +29,17 @@ }, "provisioningState": "InProgress" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", - "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", "properties": { "contentType": "application/vnd.ms-azure-apim.xsd+xml", "document": { @@ -51,7 +47,13 @@ }, "provisioningState": "InProgress" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "WorkspaceApiSchema_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApiSchema" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiVersionSet.json index 436195c85ed7..2df78f917034 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiVersionSet.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceApiVersionSet.json @@ -1,43 +1,45 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "versionSetId": "api1", "parameters": { "properties": { + "description": "Version configuration", "displayName": "api set 1", - "versioningScheme": "Segment", - "description": "Version configuration" + "versioningScheme": "Segment" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "api1", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/api1", - "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", "name": "api1", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/api1", "properties": { + "description": "Version configuration", "displayName": "api set 1", - "versioningScheme": "Segment", - "description": "Version configuration" + "versioningScheme": "Segment" } } }, "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/api1", - "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", "name": "api1", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/api1", "properties": { + "description": "Version configuration", "displayName": "api set 1", - "versioningScheme": "Segment", - "description": "Version configuration" + "versioningScheme": "Segment" } } } - } + }, + "operationId": "WorkspaceApiVersionSet_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceApiVersionSet" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceBackendProxyBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceBackendProxyBackend.json index 83ab60a9a228..c8dd46180925 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceBackendProxyBackend.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceBackendProxyBackend.json @@ -1,32 +1,14 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "backendId": "proxybackend", "parameters": { "properties": { "description": "description5308", - "url": "https://backendname2644/", - "protocol": "http", - "tls": { - "validateCertificateChain": true, - "validateCertificateName": true - }, - "proxy": { - "url": "http://192.168.1.1:8080", - "username": "Contoso\\admin", - "password": "" - }, "credentials": { - "query": { - "sv": [ - "xx", - "bb", - "cc" - ] + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" }, "header": { "x-my-1": [ @@ -34,31 +16,44 @@ "val2" ] }, - "authorization": { - "scheme": "Basic", - "parameter": "opensesma" + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] } - } + }, + "proxy": { + "password": "", + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin" + }, + "tls": { + "validateCertificateChain": true, + "validateCertificateName": true + }, + "url": "https://backendname2644/", + "protocol": "http" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", - "type": "Microsoft.ApiManagement/service/workspaces/backends", "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", "properties": { "description": "description5308", - "url": "https://backendname2644/", - "protocol": "http", "credentials": { - "query": { - "sv": [ - "xx", - "bb", - "cc" - ] + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" }, "header": { "x-my-1": [ @@ -66,39 +61,39 @@ "val2" ] }, - "authorization": { - "scheme": "Basic", - "parameter": "opensesma" + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] } }, "proxy": { + "password": "", "url": "http://192.168.1.1:8080", - "username": "Contoso\\admin", - "password": "" + "username": "Contoso\\admin" }, "tls": { "validateCertificateChain": false, "validateCertificateName": false - } + }, + "url": "https://backendname2644/", + "protocol": "http" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", - "type": "Microsoft.ApiManagement/service/workspaces/backends", "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", "properties": { "description": "description5308", - "url": "https://backendname2644/", - "protocol": "http", "credentials": { - "query": { - "sv": [ - "xx", - "bb", - "cc" - ] + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" }, "header": { "x-my-1": [ @@ -106,22 +101,29 @@ "val2" ] }, - "authorization": { - "scheme": "Basic", - "parameter": "opensesma" + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] } }, "proxy": { + "password": "", "url": "http://192.168.1.1:8080", - "username": "Contoso\\admin", - "password": "" + "username": "Contoso\\admin" }, "tls": { "validateCertificateChain": false, "validateCertificateName": false - } + }, + "url": "https://backendname2644/", + "protocol": "http" } } } - } + }, + "operationId": "WorkspaceBackend_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceBackendProxyBackend" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceBackendServiceFabric.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceBackendServiceFabric.json index 9f0a3737c1dc..6399898dba93 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceBackendServiceFabric.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceBackendServiceFabric.json @@ -1,88 +1,90 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "backendId": "sfbackend", "parameters": { "properties": { "description": "Service Fabric Test App 1", - "protocol": "http", - "url": "fabric:/mytestapp/mytestservice", "properties": { "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", "managementEndpoints": [ "https://somecluster.com" ], - "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "maxPartitionResolutionRetries": 5, "serverX509Names": [ { "name": "ServerCommonName1", "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" } - ], - "maxPartitionResolutionRetries": 5 + ] } - } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", - "type": "Microsoft.ApiManagement/service/workspaces/backends", "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", "properties": { "description": "Service Fabric Test App 1", - "url": "fabric:/mytestapp/mytestservice", - "protocol": "http", "properties": { "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", "managementEndpoints": [ "https://somecluster.com" ], - "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "maxPartitionResolutionRetries": 5, "serverX509Names": [ { "name": "ServerCommonName1", "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" } - ], - "maxPartitionResolutionRetries": 5 + ] } - } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", - "type": "Microsoft.ApiManagement/service/workspaces/backends", "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", "properties": { "description": "Service Fabric Test App 1", - "url": "fabric:/mytestapp/mytestservice", - "protocol": "http", "properties": { "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", "managementEndpoints": [ "https://somecluster.com" ], - "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "maxPartitionResolutionRetries": 5, "serverX509Names": [ { "name": "ServerCommonName1", "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" } - ], - "maxPartitionResolutionRetries": 5 + ] } - } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" } } } - } + }, + "operationId": "WorkspaceBackend_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceBackendServiceFabric" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceCertificate.json index 6123421abe8e..ebda732989ab 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceCertificate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceCertificate.json @@ -1,42 +1,44 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "certificateId": "tempcert", "parameters": { "properties": { "data": "****************Base 64 Encoded Certificate *******************************", "password": "****Certificate Password******" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/tempcert", - "type": "Microsoft.ApiManagement/service/workspaces/certificates", "name": "tempcert", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/tempcert", "properties": { + "expirationDate": "2018-03-17T21:55:07+00:00", "subject": "CN=contoso.com", - "thumbprint": "*******************3", - "expirationDate": "2018-03-17T21:55:07+00:00" + "thumbprint": "*******************3" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/tempcert", - "type": "Microsoft.ApiManagement/service/workspaces/certificates", "name": "tempcert", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/tempcert", "properties": { + "expirationDate": "2018-03-17T21:55:07+00:00", "subject": "CN=contoso.com", - "thumbprint": "*******************3", - "expirationDate": "2018-03-17T21:55:07+00:00" + "thumbprint": "*******************3" } } } - } + }, + "operationId": "WorkspaceCertificate_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceCertificate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceCertificateWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceCertificateWithKeyVault.json index f25492a8d2e7..04c2c35a61b2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceCertificateWithKeyVault.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceCertificateWithKeyVault.json @@ -1,10 +1,6 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "certificateId": "templateCertkv", "parameters": { "properties": { @@ -13,48 +9,54 @@ "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", - "type": "Microsoft.ApiManagement/service/workspaces/certificates", "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", "properties": { - "subject": "CN=*.msitesting.net", - "thumbprint": "EA**********************9AD690", "expirationDate": "2037-01-01T07:00:00Z", "keyVault": { - "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-22T00:24:53.3191468Z" - } - } + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", - "type": "Microsoft.ApiManagement/service/workspaces/certificates", "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", "properties": { - "subject": "CN=*.msitesting.net", - "thumbprint": "EA**********************9AD690", "expirationDate": "2037-01-01T07:00:00Z", "keyVault": { - "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-22T00:24:53.3191468Z" - } - } + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" } } } - } + }, + "operationId": "WorkspaceCertificate_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceCertificateWithKeyVault" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceDiagnostic.json index 2cef5114351a..2ed205f552bf 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceDiagnostic.json @@ -1,160 +1,162 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "diagnosticId": "applicationinsights", "parameters": { "properties": { "alwaysLog": "allErrors", - "loggerId": "/workspaces/wks1/loggers/azuremonitor", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/workspaces/wks1/loggers/azuremonitor", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "loggerId": "/workspaces/wks1/loggers/azuremonitor", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "loggerId": "/workspaces/wks1/loggers/applicationinsights", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/workspaces/wks1/loggers/azuremonitor", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } } } - } + }, + "operationId": "WorkspaceDiagnostic_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceEHLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceEHLogger.json index c76570f07285..cfb795ea35be 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceEHLogger.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceEHLogger.json @@ -1,52 +1,54 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "loggerId": "eh1", "parameters": { "properties": { - "loggerType": "azureEventHub", "description": "adding a new logger", "credentials": { "name": "hydraeventhub", "connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********=" - } + }, + "loggerType": "azureEventHub" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1", - "type": "Microsoft.ApiManagement/service/workspaces/loggers", "name": "eh1", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1", "properties": { - "loggerType": "azureEventHub", "description": "adding a new logger", "credentials": { "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" }, - "isBuffered": true + "isBuffered": true, + "loggerType": "azureEventHub" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1", - "type": "Microsoft.ApiManagement/service/workspaces/loggers", "name": "eh1", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1", "properties": { - "loggerType": "azureEventHub", "description": "adding a new logger", "credentials": { "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" }, - "isBuffered": true + "isBuffered": true, + "loggerType": "azureEventHub" } } } - } + }, + "operationId": "WorkspaceLogger_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceEHLogger" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceGroup.json index d9eb81d4ad7e..d52eb92dfc40 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceGroup.json @@ -1,39 +1,41 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "groupId": "tempgroup", "parameters": { "properties": { "displayName": "temp group" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup", - "type": "Microsoft.ApiManagement/service/workspaces/groups", "name": "tempgroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup", "properties": { - "displayName": "temp group", - "type": "custom" + "type": "custom", + "displayName": "temp group" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup", - "type": "Microsoft.ApiManagement/service/workspaces/groups", "name": "tempgroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup", "properties": { - "displayName": "temp group", - "type": "custom" + "type": "custom", + "displayName": "temp group" } } } - } + }, + "operationId": "WorkspaceGroup_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceGroupExternal.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceGroupExternal.json index e0d7a360db77..29cbb35af993 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceGroupExternal.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceGroupExternal.json @@ -1,46 +1,48 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "groupId": "aadGroup", "parameters": { "properties": { - "displayName": "NewGroup (samiraad.onmicrosoft.com)", - "description": "new group to test", "type": "external", + "description": "new group to test", + "displayName": "NewGroup (samiraad.onmicrosoft.com)", "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/aadGroup", - "type": "Microsoft.ApiManagement/service/workspaces/groups", "name": "aadGroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/aadGroup", "properties": { - "displayName": "NewGroup (samiraad.onmicrosoft.com)", - "description": "new group to test", "type": "external", + "description": "new group to test", + "displayName": "NewGroup (samiraad.onmicrosoft.com)", "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/aadGroup", - "type": "Microsoft.ApiManagement/service/workspaces/groups", "name": "aadGroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/aadGroup", "properties": { - "displayName": "NewGroup (samiraad.onmicrosoft.com)", - "description": "new group to test", "type": "external", + "description": "new group to test", + "displayName": "NewGroup (samiraad.onmicrosoft.com)", "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" } } } - } + }, + "operationId": "WorkspaceGroup_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceGroupExternal" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceGroupUser.json index 9a3426f2f29c..aa62c8ff5c5b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceGroupUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceGroupUser.json @@ -1,45 +1,47 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "groupId": "tempgroup", - "userId": "59307d350af58404d8a26300" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "59307d350af58404d8a26300", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/59307d350af58404d8a26300", - "type": "Microsoft.ApiManagement/service/workspaces/groups/users", "name": "59307d350af58404d8a26300", + "type": "Microsoft.ApiManagement/service/workspaces/groups/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/59307d350af58404d8a26300", "properties": { + "email": "testuser1@live.com", "firstName": "test", + "groups": [], + "identities": [], "lastName": "user", - "email": "testuser1@live.com", - "state": "active", "registrationDate": "2017-06-01T20:46:45.437Z", - "groups": [], - "identities": [] + "state": "active" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/59307d350af58404d8a26300", - "type": "Microsoft.ApiManagement/service/workspaces/groups/users", "name": "59307d350af58404d8a26300", + "type": "Microsoft.ApiManagement/service/workspaces/groups/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/59307d350af58404d8a26300", "properties": { + "email": "testuser1@live.com", "firstName": "test", + "groups": [], + "identities": [], "lastName": "user", - "email": "testuser1@live.com", - "state": "active", "registrationDate": "2017-06-01T20:46:45.437Z", - "groups": [], - "identities": [] + "state": "active" } } } - } + }, + "operationId": "WorkspaceGroupUser_Create", + "title": "ApiManagementCreateWorkspaceGroupUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNamedValue.json index 3ee652a3bdfa..a8e2bd35fb50 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNamedValue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNamedValue.json @@ -1,65 +1,67 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "namedValueId": "testprop2", "parameters": { "properties": { "displayName": "prop3name", - "value": "propValue", + "secret": false, "tags": [ "foo", "bar" ], - "secret": false + "value": "propValue" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2", - "type": "Microsoft.ApiManagement/service/workspaces/namedValues", "name": "testprop2", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2", "properties": { "displayName": "prop3name", - "value": "propValue", + "provisioningState": "InProgress", + "secret": false, "tags": [ "foo", "bar" ], - "secret": false, - "provisioningState": "InProgress" + "value": "propValue" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2", - "type": "Microsoft.ApiManagement/service/workspaces/namedValues", "name": "testprop2", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2", "properties": { "displayName": "prop3name", - "value": "propValue", + "provisioningState": "InProgress", + "secret": false, "tags": [ "foo", "bar" ], - "secret": false, - "provisioningState": "InProgress" + "value": "propValue" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "WorkspaceNamedValue_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceNamedValue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json index 3f0556c05f79..de1cd051edb6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json @@ -1,10 +1,6 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "namedValueId": "testprop6", "parameters": { "properties": { @@ -13,70 +9,76 @@ "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" }, + "secret": true, "tags": [ "foo", "bar" - ], - "secret": true + ] } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", - "type": "Microsoft.ApiManagement/service/workspaces/namedValues", "name": "testprop6", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", "properties": { "displayName": "prop6namekv", "keyVault": { - "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret", "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-11T00:54:31.8024882Z" - } + }, + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" }, + "provisioningState": "InProgress", + "secret": true, "tags": [ "foo", "bar" - ], - "secret": true, - "provisioningState": "InProgress" + ] } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", - "type": "Microsoft.ApiManagement/service/workspaces/namedValues", "name": "testprop6", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", "properties": { "displayName": "prop6namekv", "keyVault": { - "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret", "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-11T00:54:31.8024882Z" - } + }, + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" }, + "provisioningState": "InProgress", + "secret": true, "tags": [ "foo", "bar" - ], - "secret": true, - "provisioningState": "InProgress" + ] } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "WorkspaceNamedValue_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceNamedValueWithKeyVault" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNotification.json index 11f09c710e9d..5cc0fa7de327 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNotification.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNotification.json @@ -1,20 +1,19 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "notificationName": "RequestPublisherNotificationMessage" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage", - "type": "Microsoft.ApiManagement/service/workspaces/notifications", "name": "RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/workspaces/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage", "properties": { - "title": "Subscription requests (requiring approval)", "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", "recipients": { "emails": [ @@ -25,9 +24,12 @@ "users": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" ] - } + }, + "title": "Subscription requests (requiring approval)" } } } - } + }, + "operationId": "WorkspaceNotification_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceNotification" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientEmail.json index b70020eccc2e..93b302b68e7c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientEmail.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientEmail.json @@ -1,33 +1,35 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", + "email": "foobar@live.com", "notificationName": "RequestPublisherNotificationMessage", - "email": "foobar@live.com" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", - "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", "name": "foobar@live.com", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", "properties": { "email": "foobar@live.com" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", - "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", "name": "foobar@live.com", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", "properties": { "email": "foobar@live.com" } } } - } + }, + "operationId": "WorkspaceNotificationRecipientEmail_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceNotificationRecipientEmail" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientUser.json index 30cc5958d424..a0928cb90886 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceNotificationRecipientUser.json @@ -1,33 +1,35 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "notificationName": "RequestPublisherNotificationMessage", - "userId": "576823d0a40f7e74ec07d642" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "576823d0a40f7e74ec07d642", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", - "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientUsers", "name": "576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientUsers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", "properties": { "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", - "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientUsers", "name": "576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientUsers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", "properties": { "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" } } } - } + }, + "operationId": "WorkspaceNotificationRecipientUser_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceNotificationRecipientUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePolicy.json index 297698bd6a67..ef6dc56eb1e9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePolicy.json @@ -1,39 +1,41 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "policyId": "policy", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "format": "xml", "value": " " } - } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "WorkspacePolicy_CreateOrUpdate", + "title": "ApiManagementCreateWorkspacePolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePolicyFragment.json index 521efa588976..b853fb2d30d0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePolicyFragment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePolicyFragment.json @@ -1,10 +1,6 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "id": "policyFragment1", "parameters": { "properties": { @@ -12,42 +8,48 @@ "description": "A policy fragment example", "value": "" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", - "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", "properties": { "format": "xml", "description": "A policy fragment example", - "value": "", - "provisioningState": "InProgress" + "provisioningState": "InProgress", + "value": "" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } }, "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", - "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", "properties": { "format": "xml", "description": "A policy fragment example", - "value": "", - "provisioningState": "InProgress" + "provisioningState": "InProgress", + "value": "" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } } - } + }, + "operationId": "WorkspacePolicyFragment_CreateOrUpdate", + "title": "ApiManagementCreateWorkspacePolicyFragment" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePolicyNonXmlEncoded.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePolicyNonXmlEncoded.json index 7e808142eb31..ce88879f908e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePolicyNonXmlEncoded.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePolicyNonXmlEncoded.json @@ -1,39 +1,41 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "policyId": "policy", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { - "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n ", - "format": "rawxml" + "format": "rawxml", + "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n " } - } + }, + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n" } } } - } + }, + "operationId": "WorkspacePolicy_CreateOrUpdate", + "title": "ApiManagementCreateWorkspacePolicyNonXmlEncoded" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePremiumGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePremiumGateway.json index 89344d36f7c5..4a85e3ae6f4c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePremiumGateway.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspacePremiumGateway.json @@ -1,10 +1,9 @@ { "parameters": { - "gatewayName": "apimGateway1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayName": "apimGateway1", "parameters": { + "location": "South Central US", "properties": { "backend": { "subnet": { @@ -17,37 +16,31 @@ "name": "WorkspaceGatewayPremium", "capacity": 1 }, - "location": "South Central US", "tags": { "Name": "Contoso", "Test": "User" } - } + }, + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", "name": "apimGateway1", - "type": "Microsoft.ApiManagement/gateway", - "tags": { - "api-version": "2024-10-01-preview" - }, + "type": "Microsoft.ApiManagement/gateways", + "etag": "AAAAAAAmREI=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", "location": "East US", - "etag": "AAAAAAAmRAM=", "properties": { - "provisioningState": "Created", - "targetProvisioningState": "Activating", - "createdAtUtc": "2022-07-11T18:41:01.2506031Z", "backend": { "subnet": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" } }, + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "provisioningState": "Succeeded", + "targetProvisioningState": "", "virtualNetworkType": "External" }, "sku": { @@ -55,34 +48,34 @@ "capacity": 1 }, "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", "createdBy": "user@contoso.com", "createdByType": "User", - "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", "lastModifiedBy": "user@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", "name": "apimGateway1", - "type": "Microsoft.ApiManagement/gateways", - "tags": { - "api-version": "2024-10-01-preview" - }, + "type": "Microsoft.ApiManagement/gateway", + "etag": "AAAAAAAmRAM=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", "location": "East US", - "etag": "AAAAAAAmREI=", "properties": { - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2022-07-11T18:41:01.2506031Z", "backend": { "subnet": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" } }, + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "provisioningState": "Created", + "targetProvisioningState": "Activating", "virtualNetworkType": "External" }, "sku": { @@ -90,14 +83,23 @@ "capacity": 1 }, "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", "createdBy": "user@contoso.com", "createdByType": "User", - "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", "lastModifiedBy": "user@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiGateway_CreateOrUpdate", + "title": "ApiManagementCreateWorkspacePremiumGateway" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProduct.json index 134392cd6f23..bd5711592f12 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProduct.json @@ -1,43 +1,45 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "productId": "testproduct", "parameters": { "properties": { "displayName": "Test Template ProductName 4" } - } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct", - "type": "Microsoft.ApiManagement/service/workspaces/products", "name": "testproduct", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct", "properties": { - "displayName": "Test Template ProductName 4", - "subscriptionRequired": true, "approvalRequired": false, - "state": "notPublished" + "displayName": "Test Template ProductName 4", + "state": "notPublished", + "subscriptionRequired": true } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct", - "type": "Microsoft.ApiManagement/service/workspaces/products", "name": "testproduct", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct", "properties": { - "displayName": "Test Template ProductName 4", - "subscriptionRequired": true, "approvalRequired": false, - "state": "notPublished" + "displayName": "Test Template ProductName 4", + "state": "notPublished", + "subscriptionRequired": true } } } - } + }, + "operationId": "WorkspaceProduct_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceProduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProductApiLink.json index 979f1c6d33fb..b14eecb23a98 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProductApiLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProductApiLink.json @@ -1,38 +1,40 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "productId": "testproduct", "apiLinkId": "link1", "parameters": { "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" } - } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" } } } - } + }, + "operationId": "WorkspaceProductApiLink_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceProductApiLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProductGroupLink.json index 9fca83957364..aa5781f42928 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProductGroupLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProductGroupLink.json @@ -1,38 +1,40 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "productId": "testproduct", "groupLinkId": "link1", "parameters": { "properties": { "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" } - } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/groupLinkId/link1", - "type": "Microsoft.ApiManagement/service/workspaces/products/groupLinkId", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/groupLinkId", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/groupLinkId/link1", "properties": { "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/groupLinkId/link1", - "type": "Microsoft.ApiManagement/service/workspaces/products/groupLinkId", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/groupLinkId", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/groupLinkId/link1", "properties": { "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" } } } - } + }, + "operationId": "WorkspaceProductGroupLink_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceProductGroupLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProductPolicy.json index 14b5a27f0120..92f90034c541 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProductPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceProductPolicy.json @@ -1,39 +1,41 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "productId": "5702e97e5157a50f48dce801", - "policyId": "policy", "parameters": { "properties": { "format": "xml", "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } - } + }, + "policyId": "policy", + "productId": "5702e97e5157a50f48dce801", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5702e97e5157a50f48dce801/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/products/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5702e97e5157a50f48dce801/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5702e97e5157a50f48dce801/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/products/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5702e97e5157a50f48dce801/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "WorkspaceProductPolicy_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceProductPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceSchema.json index c4a82d4e719c..113b4841f7e6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceSchema.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceSchema.json @@ -1,53 +1,55 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "schemaId": "schema1", "parameters": { "properties": { "description": "sample schema description", "schemaType": "xml", "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } - } + }, + "resourceGroupName": "rg1", + "schemaId": "schema1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", - "type": "Microsoft.ApiManagement/service/workspaces/schemas", "name": "schema1", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", "properties": { "description": "sample schema description", + "provisioningState": "InProgress", "schemaType": "xml", - "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n", - "provisioningState": "InProgress" + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" } }, - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - }, + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", - "type": "Microsoft.ApiManagement/service/workspaces/schemas", "name": "schema1", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", "properties": { "description": "sample schema description", + "provisioningState": "InProgress", "schemaType": "xml", - "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n", - "provisioningState": "InProgress" + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } } - } + }, + "operationId": "WorkspaceGlobalSchema_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceSchema" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceSubscription.json index 800adf18a160..2f77dca84cce 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceSubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceSubscription.json @@ -1,47 +1,49 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "sid": "testsub", "parameters": { "properties": { + "displayName": "testsub", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", - "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", - "displayName": "testsub" + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub", - "type": "Microsoft.ApiManagement/service/workspaces.subscriptions", "name": "testsub", + "type": "Microsoft.ApiManagement/service/workspaces.subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub", "properties": { + "createdDate": "2017-06-02T23:34:03.1055076Z", + "displayName": "testsub", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", - "displayName": "testsub", - "state": "submitted", - "createdDate": "2017-06-02T23:34:03.1055076Z" + "state": "submitted" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub", - "type": "Microsoft.ApiManagement/service/workspaces.subscriptions", "name": "testsub", + "type": "Microsoft.ApiManagement/service/workspaces.subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub", "properties": { + "createdDate": "2017-06-02T23:34:03.1055076Z", + "displayName": "testsub", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", - "displayName": "testsub", - "state": "submitted", - "createdDate": "2017-06-02T23:34:03.1055076Z" + "state": "submitted" } } } - } + }, + "operationId": "WorkspaceSubscription_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceSubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTag.json index 3096198070e5..a0142a6959d9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTag.json @@ -1,37 +1,39 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "tagId": "tagId1", "parameters": { "properties": { "displayName": "tag1" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tagId1", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tagId1", - "type": "Microsoft.ApiManagement/service/workspaces/tags", "name": "tagId1", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tagId1", "properties": { "displayName": "tag1" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tagId1", - "type": "Microsoft.ApiManagement/service/workspaces/tags", "name": "tagId1", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tagId1", "properties": { "displayName": "tag1" } } } - } + }, + "operationId": "WorkspaceTag_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTagApiLink.json index 6731a6b2f356..c4b48100dd35 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTagApiLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTagApiLink.json @@ -1,38 +1,40 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "tagId": "tag1", "apiLinkId": "link1", "parameters": { "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" } } } - } + }, + "operationId": "WorkspaceTagApiLink_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceTagApiLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTagOperationLink.json index 645355a4c859..141932e13eb2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTagOperationLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTagOperationLink.json @@ -1,38 +1,40 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "tagId": "tag1", "operationLinkId": "link1", "parameters": { "properties": { "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", "properties": { "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", "properties": { "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" } } } - } + }, + "operationId": "WorkspaceTagOperationLink_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceTagOperationLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTagProductLink.json index 7fec52b9f644..37217fdbe109 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTagProductLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementCreateWorkspaceTagProductLink.json @@ -1,38 +1,40 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "tagId": "tag1", - "productLinkId": "link1", "parameters": { "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" } - } + }, + "productLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "tag1", + "workspaceId": "wks1" }, "responses": { - "201": { + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" } } } - } + }, + "operationId": "WorkspaceTagProductLink_CreateOrUpdate", + "title": "ApiManagementCreateWorkspaceTagProductLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApi.json index 7b1158c1c6b0..320e16ae32c0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApi.json @@ -1,19 +1,21 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "echo-api", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "202": { "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512288c680b?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=204", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512288c680b?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=204" } }, "204": {} - } + }, + "operationId": "Api_Delete", + "title": "ApiManagementDeleteApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiDiagnostic.json index 8250dd823064..6780346d0d1f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiDiagnostic.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "diagnosticId": "applicationinsights", "apiId": "57d1f7558aa04f15146d9d8a", - "If-Match": "*" + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "204": {}, - "200": {} - } + "200": {}, + "204": {} + }, + "operationId": "ApiDiagnostic_Delete", + "title": "ApiManagementDeleteApiDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiIssue.json index 27f8e0fc1c9f..48b5078cbf7b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiIssue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiIssue.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "issueId": "57d2ef278aa04f0ad01d6cdc", "apiId": "57d1f7558aa04f15146d9d8a", - "If-Match": "*" + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ApiIssue_Delete", + "title": "ApiManagementDeleteApiIssue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiIssueAttachment.json index e60a85e092d9..971fa6f188d6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiIssueAttachment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiIssueAttachment.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "issueId": "57d2ef278aa04f0ad01d6cdc", "apiId": "57d1f7558aa04f15146d9d8a", "attachmentId": "57d2ef278aa04f0888cba3f3", - "If-Match": "*" + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ApiIssueAttachment_Delete", + "title": "ApiManagementDeleteApiIssueAttachment" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiIssueComment.json index 3b0cc870e5a1..5e9d41eab2a1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiIssueComment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiIssueComment.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "issueId": "57d2ef278aa04f0ad01d6cdc", "apiId": "57d1f7558aa04f15146d9d8a", "commentId": "599e29ab193c3c0bd0b3e2fb", - "If-Match": "*" + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ApiIssueComment_Delete", + "title": "ApiManagementDeleteApiIssueComment" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiOperation.json index 264e7b99bb7f..fd8135b99042 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiOperation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiOperation.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "57d2ef278aa04f0ad01d6cdc", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", - "operationId": "57d2ef278aa04f0ad01d6cdc", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ApiOperation_Delete", + "title": "ApiManagementDeleteApiOperation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiOperationPolicy.json index d1d70ccc7810..16ed5266cd7e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiOperationPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiOperationPolicy.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "testoperation", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "testapi", - "operationId": "testoperation", "policyId": "policy", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ApiOperationPolicy_Delete", + "title": "ApiManagementDeleteApiOperationPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiOperationTag.json index 3a08daf6c63c..51c308db929b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiOperationTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiOperationTag.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "59d5b28d1f7fab116c282651", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "59d5b28d1f7fab116c282650", - "operationId": "59d5b28d1f7fab116c282651", - "tagId": "59d5b28e1f7fab116402044e", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59d5b28e1f7fab116402044e" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Tag_DetachFromOperation", + "title": "ApiManagementDeleteApiOperationTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiPolicy.json index 94d2e7798811..af3698c77265 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiPolicy.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "loggerId", "policyId": "policy", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ApiPolicy_Delete", + "title": "ApiManagementDeleteApiPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiRelease.json index eee455228a1a..a45d62bc04a3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiRelease.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiRelease.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "5a5fcc09124a7fa9b89f2f1d", "releaseId": "testrev", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ApiRelease_Delete", + "title": "ApiManagementDeleteApiRelease" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiSchema.json index 0701f0f8ab6d..b2c1db7c15ca 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiSchema.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiSchema.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "59d5b28d1f7fab116c282650", + "resourceGroupName": "rg1", "schemaId": "59d5b28e1f7fab116402044e", - "If-Match": "*" + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ApiSchema_Delete", + "title": "ApiManagementDeleteApiSchema" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiTag.json index 8334cd28c6db..cd088d6a86a4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiTag.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "59d5b28d1f7fab116c282650", - "tagId": "59d5b28e1f7fab116402044e", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59d5b28e1f7fab116402044e" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Tag_DetachFromApi", + "title": "ApiManagementDeleteApiTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiTagDescription.json index 9fbc14cebedf..211c3abb68bb 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiTagDescription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiTagDescription.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "59d5b28d1f7fab116c282650", - "tagDescriptionId": "59d5b28e1f7fab116402044e", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagDescriptionId": "59d5b28e1f7fab116402044e" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ApiTagDescription_Delete", + "title": "ApiManagementDeleteApiTagDescription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiVersionSet.json index 5a2062682245..f36e64d4bb80 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiVersionSet.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiVersionSet.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "versionSetId": "a1", - "If-Match": "*" + "versionSetId": "a1" }, "responses": { - "204": {}, - "200": {} - } + "200": {}, + "204": {} + }, + "operationId": "ApiVersionSet_Delete", + "title": "ApiManagementDeleteApiVersionSet" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiWiki.json index e029b507ca94..e74c947a6090 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiWiki.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteApiWiki.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d1f7558aa04f15146d9d8a", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ApiWiki_Delete", + "title": "ApiManagementDeleteApiWiki" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorization.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorization.json index a3b8c46ddba5..d27824f9c000 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorization.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorization.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "authorizationProviderId": "aadwithauthcode", "authorizationId": "authz1", - "If-Match": "*" + "authorizationProviderId": "aadwithauthcode", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Authorization_Delete", + "title": "ApiManagementDeleteAuthorization" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorizationAccessPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorizationAccessPolicy.json index a7563b20b2c2..927d249b660b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorizationAccessPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorizationAccessPolicy.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "authorizationProviderId": "aadwithauthcode", - "authorizationId": "authz1", "authorizationAccessPolicyId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", - "If-Match": "*" + "authorizationId": "authz1", + "authorizationProviderId": "aadwithauthcode", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "AuthorizationAccessPolicy_Delete", + "title": "ApiManagementDeleteAuthorizationAccessPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorizationProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorizationProvider.json index 3e028051215d..c2e55e99bc21 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorizationProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorizationProvider.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "authorizationProviderId": "aadwithauthcode", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "AuthorizationProvider_Delete", + "title": "ApiManagementDeleteAuthorizationProvider" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorizationServer.json index f834c00f4814..de1da843239a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorizationServer.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteAuthorizationServer.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "authsid": "newauthServer2", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "AuthorizationServer_Delete", + "title": "ApiManagementDeleteAuthorizationServer" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteBackend.json index cde151ed4f9c..b690ce8fa5ef 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteBackend.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteBackend.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "backendId": "sfbackend", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Backend_Delete", + "title": "ApiManagementDeleteBackend" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteCache.json index 51146205e636..30623b9151ce 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteCache.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteCache.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "cacheId": "southindia", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Cache_Delete", + "title": "ApiManagementDeleteCache" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteCertificate.json index 4aa5a2183fc5..b631a3e58ff1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteCertificate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteCertificate.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "certificateId": "tempcert", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Certificate_Delete", + "title": "ApiManagementDeleteCertificate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteClientApplication.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteClientApplication.json index a9d4b977dd61..a3b4cea96eb6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteClientApplication.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteClientApplication.json @@ -1,13 +1,15 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "clientApplicationId": "testAppId" + "clientApplicationId": "testAppId", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ClientApplication_Delete", + "title": "ApiManagementDeleteProduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteClientApplicationProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteClientApplicationProductLink.json index 9f7503577dbb..d70c766e9df7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteClientApplicationProductLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteClientApplicationProductLink.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "clientApplicationId": "testAppId", - "clientApplicationProductLinkId": "link1" + "clientApplicationProductLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ClientApplicationProductLink_Delete", + "title": "ApiManagementDeleteClientApplicationProductLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteContentType.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteContentType.json index f8c87df0e9ea..5e48036adbeb 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteContentType.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteContentType.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "contentTypeId": "page", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ContentType_Delete", + "title": "ApiManagementDeleteContentType" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteContentTypeContentItem.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteContentTypeContentItem.json index 143fb6368aeb..e4718b60fc7b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteContentTypeContentItem.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteContentTypeContentItem.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "contentTypeId": "page", "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", - "If-Match": "*" + "contentTypeId": "page", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ContentItem_Delete", + "title": "ApiManagementDeleteContentTypeContentItem" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteDiagnostic.json index 1b3ac9aba036..4ad0729158c6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteDiagnostic.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "diagnosticId": "applicationinsights", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Diagnostic_Delete", + "title": "ApiManagementDeleteDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteDocumentation.json index 50c8dd40d520..3dfd3873b1e1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteDocumentation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteDocumentation.json @@ -1,13 +1,15 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "documentationId": "57d1f7558aa04f15146d9d8a" + "documentationId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Documentation_Delete", + "title": "ApiManagementDeleteDocumentation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGateway.json index 72a73b70127b..29e3a9841073 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGateway.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGateway.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "gatewayId": "gw1", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Gateway_Delete", + "title": "ApiManagementDeleteGateway" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayApi.json index c3188f5c64bc..fc0fedd81b8c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayApi.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "gatewayId": "gw1", "apiId": "echo-api", - "If-Match": "*" + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "GatewayApi_Delete", + "title": "ApiManagementDeleteGatewayApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayCertificateAuthority.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayCertificateAuthority.json index c2aa020e4813..f192dc606d1d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayCertificateAuthority.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayCertificateAuthority.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "gatewayId": "gw1", "certificateId": "default", - "If-Match": "*" + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "GatewayCertificateAuthority_Delete", + "title": "ApiManagementDeleteGatewayCertificateAuthority" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayConfigConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayConfigConnection.json index ef1f25996913..5e2f24e5c347 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayConfigConnection.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayConfigConnection.json @@ -1,19 +1,21 @@ { "parameters": { - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "gatewayName": "standard-gw-01", "configConnectionName": "gcc-01", - "If-Match": "*" + "gatewayName": "standard-gw-01", + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "202": { "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-01?api-version=2024-10-01-preview", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-01?api-version=2024-10-01-preview" + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-01?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-01?api-version=2024-10-01-preview" } }, "204": {} - } + }, + "operationId": "ApiGatewayConfigConnection_Delete", + "title": "ApiManagementGatewayDeleteGateway" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayHostnameConfiguration.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayHostnameConfiguration.json index bbb3f8651ba8..7929e9685851 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayHostnameConfiguration.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGatewayHostnameConfiguration.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "gatewayId": "gw1", "hcId": "default", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "GatewayHostnameConfiguration_Delete", + "title": "ApiManagementDeleteGatewayHostnameConfiguration" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGlobalSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGlobalSchema.json index 1a264bad5ede..a7fbcd5362d7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGlobalSchema.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGlobalSchema.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", "schemaId": "schema1", - "If-Match": "*" + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "GlobalSchema_Delete", + "title": "ApiManagementDeleteSchema" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGraphQLApiResolver.json index 8e771468486f..2a84b14fd6d1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGraphQLApiResolver.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGraphQLApiResolver.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", "resolverId": "57d2ef278aa04f0ad01d6cdc", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "GraphQLApiResolver_Delete", + "title": "ApiManagementDeleteGraphQLApiResolver" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGraphQLApiResolverPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGraphQLApiResolverPolicy.json index 041e65d0f947..4f755bfb065b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGraphQLApiResolverPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGraphQLApiResolverPolicy.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "testapi", - "resolverId": "testResolver", "policyId": "policy", - "If-Match": "*" + "resolverId": "testResolver", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "GraphQLApiResolverPolicy_Delete", + "title": "ApiManagementDeleteGraphQLApiResolverPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGroup.json index 36baea0c0b54..3b9cc07593c2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGroup.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "groupId": "aadGroup", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Group_Delete", + "title": "ApiManagementDeleteGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGroupUser.json index 5bb88feec902..77dac2a77833 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGroupUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteGroupUser.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "groupId": "templategroup", - "userId": "59307d350af58404d8a26300", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "59307d350af58404d8a26300" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "GroupUser_Delete", + "title": "ApiManagementDeleteGroupUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteIdentityProvider.json index 788ef0b1db7d..081383933eee 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteIdentityProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteIdentityProvider.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "identityProviderName": "aad", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "IdentityProvider_Delete", + "title": "ApiManagementDeleteIdentityProvider" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteLogger.json index dba861ceb0b8..e128130a31be 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteLogger.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteLogger.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "loggerId": "loggerId", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Logger_Delete", + "title": "ApiManagementDeleteLogger" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteNamedValue.json index 60af0ff48ad5..b314bad1665e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteNamedValue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteNamedValue.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "namedValueId": "testprop2", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "NamedValue_Delete", + "title": "ApiManagementDeleteNamedValue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteNotificationRecipientEmail.json index 6dd0b029203e..1fa2004cf83a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteNotificationRecipientEmail.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteNotificationRecipientEmail.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "email": "contoso@live.com", "notificationName": "RequestPublisherNotificationMessage", - "email": "contoso@live.com" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "NotificationRecipientEmail_Delete", + "title": "ApiManagementDeleteNotificationRecipientEmail" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteNotificationRecipientUser.json index 9c489db1f90f..4f6afb68f03f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteNotificationRecipientUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteNotificationRecipientUser.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userId": "576823d0a40f7e74ec07d642" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "NotificationRecipientUser_Delete", + "title": "ApiManagementDeleteNotificationRecipientUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteOpenIdConnectProvider.json index 09516f39c15f..a63b2310707e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteOpenIdConnectProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteOpenIdConnectProvider.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "opid": "templateOpenIdConnect3", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "OpenIdConnectProvider_Delete", + "title": "ApiManagementDeleteOpenIdConnectProvider" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePolicy.json index f07a79bdb9ee..e3cc37aed034 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePolicy.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "policyId": "policy", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Policy_Delete", + "title": "ApiManagementDeletePolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePolicyFragment.json index 78ba6e18c9c2..82dc382479f0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePolicyFragment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePolicyFragment.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "id": "policyFragment1", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "PolicyFragment_Delete", + "title": "ApiManagementDeletePolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePolicyRestriction.json index f18172b4db73..9ddda353c2ff 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePolicyRestriction.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePolicyRestriction.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "policyRestrictionId": "policyRestriction1", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "PolicyRestriction_Delete", + "title": "ApiManagementDeletePolicyRestriction" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePrivateEndpointConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePrivateEndpointConnection.json index 397b1e904ec2..40818f4fea47 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePrivateEndpointConnection.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletePrivateEndpointConnection.json @@ -1,18 +1,20 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "privateEndpointConnectionName": "privateEndpointConnectionName" + "privateEndpointConnectionName": "privateEndpointConnectionName", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { + "200": {}, "202": { "headers": { "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" } }, - "200": {}, "204": {} - } + }, + "operationId": "PrivateEndpointConnection_Delete", + "title": "ApiManagementDeletePrivateEndpointConnection" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProduct.json index b3d728503a59..78104cdf6b2a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProduct.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "testproduct", "deleteSubscriptions": true, - "If-Match": "*" + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Product_Delete", + "title": "ApiManagementDeleteProduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductApi.json index 1e6bb28836ed..e14426b62872 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductApi.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "testproduct", "apiId": "echo-api", - "If-Match": "*" + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ProductApi_Delete", + "title": "ApiManagementDeleteProductApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductApiLink.json index 8f52b365e065..83286ef46180 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductApiLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductApiLink.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiLinkId": "link1", "productId": "testproduct", - "apiLinkId": "link1" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ProductApiLink_Delete", + "title": "ApiManagementDeleteProductApiLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductGroup.json index 7ad1d4a05b3c..9f1bc8cb667a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductGroup.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "testproduct", "groupId": "templateGroup", - "If-Match": "*" + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ProductGroup_Delete", + "title": "ApiManagementDeleteProductGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductGroupLink.json index cd2d42238f0f..97c9bb2c0bef 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductGroupLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductGroupLink.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupLinkId": "link1", "productId": "testproduct", - "groupLinkId": "link1" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ProductGroupLink_Delete", + "title": "ApiManagementDeleteProductGroupLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductPolicy.json index 9db2adf10694..28b765697bf9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductPolicy.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "testproduct", "policyId": "policy", - "If-Match": "*" + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ProductPolicy_Delete", + "title": "ApiManagementDeleteProductPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductTag.json index 91dad8179072..c51df84acf12 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductTag.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "productId": "59d5b28d1f7fab116c282650", - "tagId": "59d5b28e1f7fab116402044e", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "59d5b28e1f7fab116402044e" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Tag_DetachFromProduct", + "title": "ApiManagementDeleteProductTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductWiki.json index acf8d28cc3d2..fed07474a18c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductWiki.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteProductWiki.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "productId": "57d1f7558aa04f15146d9d8a", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "ProductWiki_Delete", + "title": "ApiManagementDeleteProductWiki" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteSubscription.json index 657e5c050d20..bbd2b827b747 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteSubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteSubscription.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "sid": "testsub", - "If-Match": "*" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Subscription_Delete", + "title": "ApiManagementDeleteSubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTag.json index cd6b32c3c81e..f177612ab227 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTag.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "tagId": "tagId1", - "If-Match": "*" + "tagId": "tagId1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Tag_Delete", + "title": "ApiManagementDeleteTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTagApiLink.json index 4a1ef9b3e7ce..10daf8c33663 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTagApiLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTagApiLink.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "tagId": "tag1", - "apiLinkId": "link1" + "tagId": "tag1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "TagApiLink_Delete", + "title": "ApiManagementDeleteTagApiLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTagOperationLink.json index 9ed260472154..837465e7c933 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTagOperationLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTagOperationLink.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "operationLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "tagId": "tag1", - "operationLinkId": "link1" + "tagId": "tag1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "TagOperationLink_Delete", + "title": "ApiManagementDeleteTagOperationLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTagProductLink.json index 0345ef0df7ff..225a26b3ff0d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTagProductLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTagProductLink.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "productLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "tagId": "tag1", - "productLinkId": "link1" + "tagId": "tag1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "TagProductLink_Delete", + "title": "ApiManagementDeleteTagProductLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTemplate.json index 4652600b2293..2d9650e512c4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTemplate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteTemplate.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "templateName": "newIssueNotificationMessage", - "If-Match": "*" + "templateName": "newIssueNotificationMessage" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "EmailTemplate_Delete", + "title": "ApiManagementDeleteTemplate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteUser.json index 78fd19e3b974..b1db40c4ca51 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteUser.json @@ -1,19 +1,21 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userId": "5931a75ae4bbd512288c680b", - "If-Match": "*" + "userId": "5931a75ae4bbd512288c680b" }, "responses": { "202": { "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=204", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=204" } }, "204": {} - } + }, + "operationId": "User_Delete", + "title": "ApiManagementDeleteUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspace.json index 415c757042ae..efc10ec3ab01 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspace.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspace.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "If-Match": "*" + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "Workspace_Delete", + "title": "ApiManagementDeleteWorkspace" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApi.json index ce5943e30eb1..1ea74daceca1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApi.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "echo-api", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceApi_Delete", + "title": "ApiManagementDeleteWorkspaceApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiDiagnostic.json index cb8dc5877259..3d32518f6d4b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiDiagnostic.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "diagnosticId": "applicationinsights", "apiId": "57d1f7558aa04f15146d9d8a", - "If-Match": "*" + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "204": {}, - "200": {} - } + "200": {}, + "204": {} + }, + "operationId": "WorkspaceApiDiagnostic_Delete", + "title": "ApiManagementDeleteWorkspaceApiDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiOperation.json index 03e6bca2e1aa..12ea3ca102d4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiOperation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiOperation.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "57d2ef278aa04f0ad01d6cdc", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "57d2ef278aa04f0888cba3f3", - "operationId": "57d2ef278aa04f0ad01d6cdc", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceApiOperation_Delete", + "title": "ApiManagementDeleteWorkspaceApiOperation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiOperationPolicy.json index 5a897d1a317e..42d81cbcd4d1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiOperationPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiOperationPolicy.json @@ -1,17 +1,19 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "testoperation", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "testapi", - "operationId": "testoperation", "policyId": "policy", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceApiOperationPolicy_Delete", + "title": "ApiManagementDeleteWorkspaceApiOperationPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiPolicy.json index 17e500e3928f..c0df716e5225 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiPolicy.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "loggerId", "policyId": "policy", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceApiPolicy_Delete", + "title": "ApiManagementDeleteWorkspaceApiPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiRelease.json index 4465c4d706cf..0b8e52277a51 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiRelease.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiRelease.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "5a5fcc09124a7fa9b89f2f1d", "releaseId": "testrev", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceApiRelease_Delete", + "title": "ApiManagementDeleteWorkspaceApiRelease" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiSchema.json index 37cd2d6f75ca..d51670f08ae7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiSchema.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiSchema.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "59d5b28d1f7fab116c282650", + "resourceGroupName": "rg1", "schemaId": "59d5b28e1f7fab116402044e", - "If-Match": "*" + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceApiSchema_Delete", + "title": "ApiManagementDeleteWorkspaceApiSchema" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiVersionSet.json index da69562e58c4..0b23a07921bd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiVersionSet.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceApiVersionSet.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "versionSetId": "a1", - "If-Match": "*" + "workspaceId": "wks1" }, "responses": { - "204": {}, - "200": {} - } + "200": {}, + "204": {} + }, + "operationId": "WorkspaceApiVersionSet_Delete", + "title": "ApiManagementDeleteWorkspaceApiVersionSet" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceBackend.json index a16a6769e4c1..b8350ee2c415 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceBackend.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceBackend.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "backendId": "sfbackend", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceBackend_Delete", + "title": "ApiManagementDeleteWorkspaceBackend" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceCertificate.json index 1c102ca8ff80..29ce348268c6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceCertificate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceCertificate.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "certificateId": "tempcert", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceCertificate_Delete", + "title": "ApiManagementDeleteWorkspaceCertificate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceDiagnostic.json index c1db99f57edf..ec3ebcc9b25f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceDiagnostic.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "diagnosticId": "applicationinsights", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceDiagnostic_Delete", + "title": "ApiManagementDeleteWorkspaceDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceGroup.json index b5d602e92855..bfe9667f003a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceGroup.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "groupId": "aadGroup", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceGroup_Delete", + "title": "ApiManagementDeleteWorkspaceGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceGroupUser.json index 672207f5e243..9d7770098be2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceGroupUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceGroupUser.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "groupId": "templategroup", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userId": "59307d350af58404d8a26300", - "If-Match": "*" + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceGroupUser_Delete", + "title": "ApiManagementDeleteWorkspaceGroupUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceLogger.json index 87162d60809c..b6c21be64890 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceLogger.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceLogger.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "loggerId": "loggerId", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceLogger_Delete", + "title": "ApiManagementDeleteWorkspaceLogger" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceNamedValue.json index c672b4b6599d..2e8b804d34af 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceNamedValue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceNamedValue.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "namedValueId": "testprop2", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceNamedValue_Delete", + "title": "ApiManagementDeleteWorkspaceNamedValue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientEmail.json index c22ff3dd24e7..24c1acd7f7f9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientEmail.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientEmail.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", + "email": "contoso@live.com", "notificationName": "RequestPublisherNotificationMessage", - "email": "contoso@live.com" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceNotificationRecipientEmail_Delete", + "title": "ApiManagementDeleteWorkspaceNotificationRecipientEmail" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientUser.json index 36044f78e837..c3ddb6b2eea0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceNotificationRecipientUser.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "notificationName": "RequestPublisherNotificationMessage", - "userId": "576823d0a40f7e74ec07d642" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "576823d0a40f7e74ec07d642", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceNotificationRecipientUser_Delete", + "title": "ApiManagementDeleteWorkspaceNotificationRecipientUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspacePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspacePolicy.json index 07a2d3fbab2c..e793b28e4f35 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspacePolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspacePolicy.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "policyId": "policy", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspacePolicy_Delete", + "title": "ApiManagementDeleteWorkspacePolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspacePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspacePolicyFragment.json index a64842795518..5143e6e08455 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspacePolicyFragment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspacePolicyFragment.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "id": "policyFragment1", - "If-Match": "*" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspacePolicyFragment_Delete", + "title": "ApiManagementDeleteWorkspacePolicyFragment" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProduct.json index fe24b92ef502..7f9fe7fd6e6b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProduct.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "productId": "testproduct", "deleteSubscriptions": true, - "If-Match": "*" + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceProduct_Delete", + "title": "ApiManagementDeleteWorkspaceProduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProductApiLink.json index 3b42eb78974e..9d8a1fa70aef 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProductApiLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProductApiLink.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", + "apiLinkId": "link1", "productId": "testproduct", - "apiLinkId": "link1" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceProductApiLink_Delete", + "title": "ApiManagementDeleteWorkspaceProductApiLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProductGroupLink.json index f54dff4b49f9..92ce6bec1ccc 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProductGroupLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProductGroupLink.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", + "groupLinkId": "link1", "productId": "testproduct", - "groupLinkId": "link1" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceProductGroupLink_Delete", + "title": "ApiManagementDeleteWorkspaceProductGroupLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProductPolicy.json index 1b27ae022ebb..4f6251fcaf73 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProductPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceProductPolicy.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "productId": "testproduct", "policyId": "policy", - "If-Match": "*" + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceProductPolicy_Delete", + "title": "ApiManagementDeleteWorkspaceProductPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceSchema.json index cdd5e22711ff..e6cd6da1acc8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceSchema.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceSchema.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", + "resourceGroupName": "rg1", "schemaId": "schema1", - "If-Match": "*" + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceGlobalSchema_Delete", + "title": "ApiManagementDeleteWorkspaceSchema" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceSubscription.json index f737ce5bc39c..195c1c480443 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceSubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceSubscription.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "sid": "testsub", - "If-Match": "*" + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceSubscription_Delete", + "title": "ApiManagementDeleteWorkspaceSubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTag.json index 4d9d0ce48516..3101f492547d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTag.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "tagId": "tagId1", - "If-Match": "*" + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceTag_Delete", + "title": "ApiManagementDeleteWorkspaceTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTagApiLink.json index ac4a6bd6e6f5..894c619a3db7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTagApiLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTagApiLink.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "tagId": "tag1", - "apiLinkId": "link1" + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceTagApiLink_Delete", + "title": "ApiManagementDeleteWorkspaceTagApiLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTagOperationLink.json index 0967b45a3501..241d3c9cec8c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTagOperationLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTagOperationLink.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "operationLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "tagId": "tag1", - "operationLinkId": "link1" + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceTagOperationLink_Delete", + "title": "ApiManagementDeleteWorkspaceTagOperationLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTagProductLink.json index 60cfa10ff0a2..fd1f0fc2f4c1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTagProductLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeleteWorkspaceTagProductLink.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "productLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "tagId": "tag1", - "productLinkId": "link1" + "workspaceId": "wks1" }, "responses": { "200": {}, "204": {} - } + }, + "operationId": "WorkspaceTagProductLink_Delete", + "title": "ApiManagementDeleteWorkspaceTagProductLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletedServicesListBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletedServicesListBySubscription.json index 7cd16aea335c..e45423c5adaf 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletedServicesListBySubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletedServicesListBySubscription.json @@ -8,29 +8,31 @@ "body": { "value": [ { - "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3", "name": "apimService3", "type": "Microsoft.ApiManagement/deletedservices", + "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3", "location": "West US", "properties": { - "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3", + "deletionDate": "2017-05-27T15:33:55.5426123Z", "scheduledPurgeDate": "2017-05-27T15:33:55.5426123Z", - "deletionDate": "2017-05-27T15:33:55.5426123Z" + "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3" } }, { - "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus2/deletedservices/apimService", "name": "apimService", "type": "Microsoft.ApiManagement/deletedservices", + "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus2/deletedservices/apimService", "location": "West US 2", "properties": { - "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService", + "deletionDate": "2017-05-27T15:33:55.5426123Z", "scheduledPurgeDate": "2017-05-27T15:33:55.5426123Z", - "deletionDate": "2017-05-27T15:33:55.5426123Z" + "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService" } } ] } } - } + }, + "operationId": "DeletedServices_ListBySubscription", + "title": "ApiManagementDeletedServicesListBySubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletedServicesPurge.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletedServicesPurge.json index 735de7f0336c..0b8978505ea7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletedServicesPurge.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementDeletedServicesPurge.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService3", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "location": "westus" + "location": "westus", + "serviceName": "apimService3", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { + "200": {}, "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2024-10-01-preview" - }, "body": { - "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3", "name": "apimService3", "type": "Microsoft.ApiManagement/deletedservices", + "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3", "location": "West US", "properties": { - "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3", + "deletionDate": "2017-05-27T15:33:55.5426123Z", "scheduledPurgeDate": "2017-05-27T15:33:55.5426123Z", - "deletionDate": "2017-05-27T15:33:55.5426123Z" + "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3" } + }, + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2024-10-01-preview" } }, - "200": {}, "204": {} - } + }, + "operationId": "DeletedServices_Purge", + "title": "ApiManagementDeletedServicesPurge" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayDeleteGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayDeleteGateway.json index 88ad2307598f..e8eba3e1de4b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayDeleteGateway.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayDeleteGateway.json @@ -1,29 +1,19 @@ { "parameters": { + "api-version": "2024-10-01-preview", "gatewayName": "example-gateway", "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateway/example-gateway/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2024-10-01-preview" - }, "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateway/example-gateway", "name": "example-gateway", "type": "Microsoft.ApiManagement/gateway", - "tags": {}, - "location": "West US", "etag": "AAAAAAFfhHY=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateway/example-gateway", + "location": "West US", "properties": { - "provisioningState": "Succeeded", - "targetProvisioningState": "Deleting", - "createdAtUtc": "2016-12-20T19:41:21.5823069Z", - "frontend": { - "defaultHostname": "example-gateway.westus.gateway.azure-api.net" - }, "backend": { "subnet": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" @@ -31,14 +21,26 @@ }, "configurationApi": { "hostname": "example-gateway.westus.configuration.gateway.azure-api.net" - } + }, + "createdAtUtc": "2016-12-20T19:41:21.5823069Z", + "frontend": { + "defaultHostname": "example-gateway.westus.gateway.azure-api.net" + }, + "provisioningState": "Succeeded", + "targetProvisioningState": "Deleting" }, "sku": { "name": "Standard", "capacity": 1 - } + }, + "tags": {} + }, + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateway/example-gateway/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2024-10-01-preview" } }, "204": {} - } + }, + "operationId": "ApiGateway_Delete", + "title": "ApiManagementGatewayDeleteGateway" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayGenerateToken.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayGenerateToken.json index 27a93aabbe25..110ec7b948b5 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayGenerateToken.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayGenerateToken.json @@ -1,14 +1,14 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "gatewayId": "gw1", "parameters": { - "keyType": "primary", - "expiry": "2020-04-21T00:44:24.2845269Z" - } + "expiry": "2020-04-21T00:44:24.2845269Z", + "keyType": "primary" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -16,5 +16,7 @@ "value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg==" } } - } + }, + "operationId": "Gateway_GenerateToken", + "title": "ApiManagementGatewayGenerateToken" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayGetGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayGetGateway.json index 090342adfd4a..b6d2825c0b8f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayGetGateway.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayGetGateway.json @@ -1,29 +1,19 @@ { "parameters": { + "api-version": "2024-10-01-preview", "gatewayName": "apimService1", "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateway/example-gateway", "name": "example-gateway", "type": "Microsoft.ApiManagement/gateway", - "tags": { - "owner": "v-aswmoh", - "ReleaseName": "Z3" - }, - "location": "East US", "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateway/example-gateway", + "location": "East US", "properties": { - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2021-06-16T09:40:00.9453556Z", - "frontend": { - "defaultHostname": "example-gateway.eastus.gateway.azure-api.net" - }, "backend": { "subnet": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" @@ -31,21 +21,33 @@ }, "configurationApi": { "hostname": "example-gateway.eastus.configuration.gateway.azure-api.net" - } + }, + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "frontend": { + "defaultHostname": "example-gateway.eastus.gateway.azure-api.net" + }, + "provisioningState": "Succeeded", + "targetProvisioningState": "" }, "sku": { "name": "Standard", "capacity": 1 }, "systemData": { + "createdAt": "2021-06-16T09:40:00.7106733Z", "createdBy": "string", "createdByType": "User", - "createdAt": "2021-06-16T09:40:00.7106733Z", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z", "lastModifiedBy": "foo@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-06-20T06:33:09.6159006Z" + "lastModifiedByType": "User" + }, + "tags": { + "ReleaseName": "Z3", + "owner": "v-aswmoh" } } } - } + }, + "operationId": "ApiGateway_Get", + "title": "ApiManagementGatewayGetGateway" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayInvalidateDebugCredentials.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayInvalidateDebugCredentials.json index 7d03b77327b7..6b80b36b409b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayInvalidateDebugCredentials.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayInvalidateDebugCredentials.json @@ -1,12 +1,14 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "gatewayId": "gw1" + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "204": {} - } + }, + "operationId": "Gateway_InvalidateDebugCredentials", + "title": "ApiManagementGatewayInvalidateDebugCredentials" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayListDebugCredentials.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayListDebugCredentials.json index 3833d11af654..7904278542d2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayListDebugCredentials.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayListDebugCredentials.json @@ -1,17 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "gatewayId": "gw1", "parameters": { - "credentialsExpireAfter": "PT1H", "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "credentialsExpireAfter": "PT1H", "purposes": [ "tracing" ] - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -19,5 +19,7 @@ "token": "p=tracing&aid=a1&ex=20230504000000&sn=ZdfxSJoCsOJE0/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/8LchGl7gu/Q==" } } - } + }, + "operationId": "Gateway_ListDebugCredentials", + "title": "ApiManagementGatewayListDebugCredentials" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayListKeys.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayListKeys.json index 89418553ae44..e4904961a7d3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayListKeys.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayListKeys.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "gatewayId": "gw1" + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "secondary": "secondary_key_value" } } - } + }, + "operationId": "Gateway_ListKeys", + "title": "ApiManagementGatewayListKeys" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayListTrace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayListTrace.json index 6498eee052a5..e981180d9506 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayListTrace.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayListTrace.json @@ -1,112 +1,114 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "gatewayId": "gw1", "parameters": { "traceId": "CrDvXXXXXXXXXXXXXVU3ZA2-1" - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "serviceName": "apimService1", - "traceId": "1e0447d4-XXXX-XXXX-XXXX-dbdb8098a0d3", "traceEntries": { "inbound": [ { - "source": "api-inspector", - "timestamp": "2023-05-03T12:03:04.6899436Z", - "elapsed": "00:00:00.2983315", "data": { "request": { "method": "GET", - "url": "https://proxy.msitesting.net/6452XXXXXXXXXXXX9c2facb1/64524dXXXXXXXXXXXX2facb3?subscription-key=117313e70XXXXXXXXXXXX38ba4658ca3", "headers": [ { "name": "Host", "value": "proxy.msitesting.net" } - ] + ], + "url": "https://proxy.msitesting.net/6452XXXXXXXXXXXX9c2facb1/64524dXXXXXXXXXXXX2facb3?subscription-key=117313e70XXXXXXXXXXXX38ba4658ca3" } - } + }, + "elapsed": "00:00:00.2983315", + "source": "api-inspector", + "timestamp": "2023-05-03T12:03:04.6899436Z" }, { - "source": "api-inspector", - "timestamp": "2023-05-03T12:03:04.6969650Z", - "elapsed": "00:00:00.3046329", "data": { "configuration": { "api": { "from": "/6452XXXXXXXXXXXX9c2facb1", + "revision": "1", "to": { - "scheme": "http", + "path": "/", "host": "msitesting.net", + "isDefaultPort": true, "port": 80, - "path": "/", - "queryString": "", "query": {}, - "isDefaultPort": true + "queryString": "", + "scheme": "http" }, - "version": null, - "revision": "1" + "version": null }, "operation": { "method": "GET", "uriTemplate": "/64524dXXXXXXXXXXXX2facb3" }, - "user": "-", - "product": "-" + "product": "-", + "user": "-" } - } + }, + "elapsed": "00:00:00.3046329", + "source": "api-inspector", + "timestamp": "2023-05-03T12:03:04.6969650Z" }, { - "source": "cors", - "timestamp": "2023-05-03T12:03:04.9901631Z", + "data": "Origin header was missing or empty and the request was classified as not cross-domain. CORS policy was not applied.", "elapsed": "00:00:00.5972352", - "data": "Origin header was missing or empty and the request was classified as not cross-domain. CORS policy was not applied." + "source": "cors", + "timestamp": "2023-05-03T12:03:04.9901631Z" }, { - "source": "set-status", - "timestamp": "2023-05-03T12:03:05.0031202Z", - "elapsed": "00:00:00.6107970", "data": { "message": [ "Response status code was set to 200", "Response status reason was set to 'OK'" ] - } + }, + "elapsed": "00:00:00.6107970", + "source": "set-status", + "timestamp": "2023-05-03T12:03:05.0031202Z" }, { - "source": "return-response", - "timestamp": "2023-05-03T12:03:05.0086543Z", - "elapsed": "00:00:00.6164228", "data": { "message": "Return response was applied", "response": { + "headers": [], "status": { "code": "OK", "reason": "OK" - }, - "headers": [] + } } - } + }, + "elapsed": "00:00:00.6164228", + "source": "return-response", + "timestamp": "2023-05-03T12:03:05.0086543Z" } ], "outbound": [ { - "source": "transfer-response", - "timestamp": "2023-05-03T12:03:05.0438287Z", - "elapsed": "00:00:00.6510195", "data": { "message": "Response has been sent to the caller in full" - } + }, + "elapsed": "00:00:00.6510195", + "source": "transfer-response", + "timestamp": "2023-05-03T12:03:05.0438287Z" } ] - } + }, + "traceId": "1e0447d4-XXXX-XXXX-XXXX-dbdb8098a0d3" } } - } + }, + "operationId": "Gateway_ListTrace", + "title": "ApiManagementGatewayListTrace" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayRegenerateKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayRegenerateKey.json index 099b4963746f..a2c40b385169 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayRegenerateKey.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGatewayRegenerateKey.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "gatewayId": "gwId", "parameters": { "keyType": "primary" - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "204": {} - } + }, + "operationId": "Gateway_RegenerateKey", + "title": "ApiManagementGatewayRegenerateKey" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiContract.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiContract.json index 58d84218bcd1..97d366758e78 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiContract.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiContract.json @@ -1,25 +1,21 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "57d1f7558aa04f15146d9d8a" + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", - "type": "Microsoft.ApiManagement/service/apis", "name": "57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", "properties": { - "displayName": "Service", - "apiRevision": "1", - "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "type": "soap", "path": "schulte", - "protocols": [ - "https" - ], + "apiRevision": "1", "authenticationSettings": { "oAuth2": { "authorizationServerId": "authorizationServerId2283", @@ -36,15 +32,21 @@ } ] }, + "displayName": "Service", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "https" + ], + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "type": "soap", - "isCurrent": true, - "isOnline": true + } } } } - } + }, + "operationId": "Api_Get", + "title": "ApiManagementGetApiContract" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiDiagnostic.json index 7705db640f2c..c1da6275689c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiDiagnostic.json @@ -1,57 +1,59 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a", "diagnosticId": "applicationinsights", - "apiId": "57d1f7558aa04f15146d9d8a" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/apis/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "httpCorrelationProtocol": "Legacy", - "logClientIp": true, - "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", - "sampling": { - "samplingType": "fixed", - "percentage": 100 - }, - "frontend": { - "request": { - "headers": [], + "backend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } }, - "backend": { - "request": { - "headers": [], + "frontend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" } } } } - } + }, + "operationId": "ApiDiagnostic_Get", + "title": "ApiManagementGetApiDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiExportInOpenApi2dot0.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiExportInOpenApi2dot0.json index 9deb319d55b7..947a047cc09a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiExportInOpenApi2dot0.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiExportInOpenApi2dot0.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "format": "swagger-link", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "echo-api", - "format": "swagger-link", - "export": "true" + "export": "true", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", "format": "swagger-link-json", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", "value": { "link": "https://apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore Extensive.json?XXXXXXXX" } } } - } + }, + "operationId": "ApiExport_Get", + "title": "ApiManagementGetApiExportInOpenApi2dot0" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiExportInOpenApi3dot0.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiExportInOpenApi3dot0.json index 7a9109700739..10cc4757363d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiExportInOpenApi3dot0.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiExportInOpenApi3dot0.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "format": "openapi-link", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "aid9676", - "format": "openapi-link", - "export": "true" + "export": "true", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/aid9676", "format": "openapi-link", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/aid9676", "value": { "link": "https: //apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore.yaml?storage-sas-signatureXXXX" } } } - } + }, + "operationId": "ApiExport_Get", + "title": "ApiManagementGetApiExportInOpenApi3dot0" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiIssue.json index e697d9511062..3a6234c47b87 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiIssue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiIssue.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", - "issueId": "57d2ef278aa04f0ad01d6cdc" + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/apis/issues", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", "properties": { - "title": "New API issue", "description": "New API issue description", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", "createdDate": "2018-02-01T22:21:20.467Z", "state": "open", - "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", - "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a" + "title": "New API issue", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" } } } - } + }, + "operationId": "ApiIssue_Get", + "title": "ApiManagementGetApiIssue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiIssueAttachment.json index 098a60150fbf..25f3e54f6ae4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiIssueAttachment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiIssueAttachment.json @@ -1,25 +1,27 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", + "attachmentId": "57d2ef278aa04f0888cba3f3", "issueId": "57d2ef278aa04f0ad01d6cdc", - "attachmentId": "57d2ef278aa04f0888cba3f3" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", - "type": "Microsoft.ApiManagement/service/apis/issues/attachments", "name": "57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", "properties": { - "title": "Issue attachment.", + "content": "https://.../image.jpg", "contentFormat": "link", - "content": "https://.../image.jpg" + "title": "Issue attachment." } } } - } + }, + "operationId": "ApiIssueAttachment_Get", + "title": "ApiManagementGetApiIssueAttachment" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiIssueComment.json index c03515998dd9..1d5712f24b5d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiIssueComment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiIssueComment.json @@ -1,25 +1,27 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", + "commentId": "599e29ab193c3c0bd0b3e2fb", "issueId": "57d2ef278aa04f0ad01d6cdc", - "commentId": "599e29ab193c3c0bd0b3e2fb" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", - "type": "Microsoft.ApiManagement/service/apis/issues/comments", "name": "599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", "properties": { - "text": "Issue comment.", "createdDate": "2018-02-01T22:21:20.467Z", + "text": "Issue comment.", "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" } } } - } + }, + "operationId": "ApiIssueComment_Get", + "title": "ApiManagementGetApiIssueComment" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperation.json index 065a3d5d7e77..7cf749f7d8f9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperation.json @@ -1,27 +1,27 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "57d2ef278aa04f0ad01d6cdc", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", - "operationId": "57d2ef278aa04f0ad01d6cdc" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/apis/operations", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", "properties": { - "displayName": "CancelOrder", "method": "POST", - "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", + "displayName": "CancelOrder", "templateParameters": [], + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", "request": { "description": "IFazioService_CancelOrder_InputMessage", - "queryParameters": [], "headers": [], + "queryParameters": [], "representations": [ { "contentType": "text/xml", @@ -32,8 +32,8 @@ }, "responses": [ { - "statusCode": 200, "description": "IFazioService_CancelOrder_OutputMessage", + "headers": [], "representations": [ { "contentType": "text/xml", @@ -41,11 +41,13 @@ "typeName": "CancelOrderResponse" } ], - "headers": [] + "statusCode": 200 } ] } } } - } + }, + "operationId": "ApiOperation_Get", + "title": "ApiManagementGetApiOperation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperationPetStore.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperationPetStore.json index 2a3221ed0d81..a71d1ec77bd3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperationPetStore.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperationPetStore.json @@ -1,48 +1,61 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "loginUser", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "swagger-petstore", - "operationId": "loginUser" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/swagger-petstore/operations/loginUser", - "type": "Microsoft.ApiManagement/service/apis/operations", "name": "loginUser", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/swagger-petstore/operations/loginUser", "properties": { - "displayName": "Logs user into the system", "method": "GET", - "urlTemplate": "/user/login?username={username}&password={password}", + "description": "", + "displayName": "Logs user into the system", "templateParameters": [ { "name": "username", - "description": "The user name for login", "type": "string", + "description": "The user name for login", "required": true, "values": [] }, { "name": "password", - "description": "The password for login in clear text", "type": "string", + "description": "The password for login in clear text", "required": true, "values": [] } ], - "description": "", + "urlTemplate": "/user/login?username={username}&password={password}", "request": { - "queryParameters": [], "headers": [], + "queryParameters": [], "representations": [] }, "responses": [ { - "statusCode": 200, "description": "successful operation", + "headers": [ + { + "name": "X-Rate-Limit", + "type": "integer", + "description": "calls per hour allowed by the user", + "values": [] + }, + { + "name": "X-Expires-After", + "type": "string", + "description": "date in UTC when token expires", + "values": [] + } + ], "representations": [ { "contentType": "application/xml", @@ -55,24 +68,11 @@ "typeName": "UserLoginGet200ApplicationJsonResponse" } ], - "headers": [ - { - "name": "X-Rate-Limit", - "description": "calls per hour allowed by the user", - "type": "integer", - "values": [] - }, - { - "name": "X-Expires-After", - "description": "date in UTC when token expires", - "type": "string", - "values": [] - } - ] + "statusCode": 200 }, { - "statusCode": 400, "description": "Invalid username/password supplied", + "headers": [], "representations": [ { "contentType": "application/xml" @@ -81,11 +81,13 @@ "contentType": "application/json" } ], - "headers": [] + "statusCode": 400 } ] } } } - } + }, + "operationId": "ApiOperation_Get", + "title": "ApiManagementGetApiOperationPetStore" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperationPolicy.json index 7e2ea354124e..d6ef8f269991 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperationPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperationPolicy.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "5600b53ac53f5b0062080006", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "5600b539c53f5b0062040001", - "operationId": "5600b53ac53f5b0062080006", - "policyId": "policy" + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/operations/5600b53ac53f5b0062080006/policies/policy", - "type": "Microsoft.ApiManagement/service/apis/operations/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/operations/5600b53ac53f5b0062080006/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n This is a sample\r\n \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "ApiOperationPolicy_Get", + "title": "ApiManagementGetApiOperationPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperationTag.json index c01a2b023fc7..82c98dfe9bb3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperationTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiOperationTag.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "59d6bb8f1f7fab13dc67ec9a", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "59d6bb8f1f7fab13dc67ec9b", - "operationId": "59d6bb8f1f7fab13dc67ec9a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagId": "59306a29e4bbd510dc24e5f9" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", - "type": "Microsoft.ApiManagement/service/tags", "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", "properties": { "displayName": "tag1" } } } - } + }, + "operationId": "Tag_GetByOperation", + "title": "ApiManagementGetApiOperationTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiPolicy.json index 959f09d0a758..e5995ea87158 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiPolicy.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "5600b59475ff190048040001", - "policyId": "policy" + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b59475ff190048040001/policies/policy", - "type": "Microsoft.ApiManagement/service/apis/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b59475ff190048040001/policies/policy", "properties": { "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "ApiPolicy_Get", + "title": "ApiManagementGetApiPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiRelease.json index 6c0b5ab7fbe5..d3ecb80b5edc 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiRelease.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiRelease.json @@ -1,25 +1,27 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "a1", - "releaseId": "5a7cb545298324c53224a799" + "releaseId": "5a7cb545298324c53224a799", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/5a7cb545298324c53224a799", - "type": "Microsoft.ApiManagement/service/apis/releases", "name": "5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/5a7cb545298324c53224a799", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", "createdDateTime": "2018-02-08T20:38:29.173Z", - "updatedDateTime": "2018-02-08T20:38:29.173Z", - "notes": "yahoo" + "notes": "yahoo", + "updatedDateTime": "2018-02-08T20:38:29.173Z" } } } - } + }, + "operationId": "ApiRelease_Get", + "title": "ApiManagementGetApiRelease" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiRevision.json index 98dde4902f85..14f2f21c5c0b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiRevision.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiRevision.json @@ -1,25 +1,21 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "echo-api;rev=3" + "apiId": "echo-api;rev=3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", - "type": "Microsoft.ApiManagement/service/apis", "name": "echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", "properties": { - "displayName": "Service", - "apiRevision": "3", - "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", "path": "schulte", - "protocols": [ - "https" - ], + "apiRevision": "3", + "apiRevisionDescription": "fixed bug in contract", "authenticationSettings": { "oAuth2": { "authorizationServerId": "authorizationServerId2283", @@ -36,13 +32,19 @@ } ] }, + "displayName": "Service", + "protocols": [ + "https" + ], + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "apiRevisionDescription": "fixed bug in contract" + } } } } - } + }, + "operationId": "Api_Get", + "title": "ApiManagementGetApiRevisionContract" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiSchema.json index ea0d172f0e6e..718ae7b32a63 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiSchema.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiSchema.json @@ -1,18 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "59d6bb8f1f7fab13dc67ec9b", - "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1" + "resourceGroupName": "rg1", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", - "type": "Microsoft.ApiManagement/service/apis/schemas", "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", "properties": { "contentType": "application/vnd.ms-azure-apim.xsd+xml", "document": { @@ -21,5 +21,7 @@ } } } - } + }, + "operationId": "ApiSchema_Get", + "title": "ApiManagementGetApiSchema" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiTag.json index 9320f34a5903..636e493a619d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiTag.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "59d6bb8f1f7fab13dc67ec9b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagId": "59306a29e4bbd510dc24e5f9" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", - "type": "Microsoft.ApiManagement/service/tags", "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", "properties": { "displayName": "tag1" } } } - } + }, + "operationId": "Tag_GetByApi", + "title": "ApiManagementGetApiTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiTagDescription.json index 0d493841b9ed..ed4abb785c44 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiTagDescription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiTagDescription.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "59d6bb8f1f7fab13dc67ec9b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagDescriptionId": "59306a29e4bbd510dc24e5f9" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/tagDescriptions/59306a29e4bbd510dc24e5f9", - "type": "Microsoft.ApiManagement/service/apis/tagDescriptions", "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/apis/tagDescriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/tagDescriptions/59306a29e4bbd510dc24e5f9", "properties": { - "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", - "displayName": "tag1", "description": null, + "displayName": "tag1", "externalDocsDescription": "some additional info", - "externalDocsUrl": "http://some_url.com" + "externalDocsUrl": "http://some_url.com", + "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9" } } } - } + }, + "operationId": "ApiTagDescription_Get", + "title": "ApiManagementGetApiTagDescription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiVersionSet.json index 7732ea5dad16..c2f1fae46afa 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiVersionSet.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiVersionSet.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "versionSetId": "vs1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1", - "type": "Microsoft.ApiManagement/service/api-version-sets", "name": "vs1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1", "properties": { + "description": "Version configuration", "displayName": "Version Set 1", - "versioningScheme": "Segment", - "description": "Version configuration" + "versioningScheme": "Segment" } } } - } + }, + "operationId": "ApiVersionSet_Get", + "title": "ApiManagementGetApiVersionSet" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiWiki.json index 7d4a5561e695..7126baa24fdd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiWiki.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetApiWiki.json @@ -1,17 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "57d1f7558aa04f15146d9d8a" + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", - "type": "Microsoft.ApiManagement/service/apis/wikis", "name": "default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", "properties": { "documents": [ { @@ -24,5 +24,7 @@ } } } - } + }, + "operationId": "ApiWiki_Get", + "title": "ApiManagementGetApiWiki" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorization.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorization.json index aba39c507e55..9be2c398907c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorization.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorization.json @@ -1,18 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationId": "authz1", "authorizationProviderId": "aadwithauthcode", - "authorizationId": "authz1" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1", - "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", "name": "authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1", "properties": { "authorizationType": "OAuth2", "oauth2grantType": "AuthorizationCode", @@ -20,5 +20,7 @@ } } } - } + }, + "operationId": "Authorization_Get", + "title": "ApiManagementGetAuthorization" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationAccessPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationAccessPolicy.json index 53f2f49b5e1d..46d4a8cdfe0d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationAccessPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationAccessPolicy.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "authorizationProviderId": "aadwithauthcode", + "authorizationAccessPolicyId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", "authorizationId": "authz1", - "authorizationAccessPolicyId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab" + "authorizationProviderId": "aadwithauthcode", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies", - "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies/fe0bed83-631f-4149-bd0b-0464b1bc7cab", "properties": { "appIds": [ "d5f04bb0-ba78-4878-a43e-35a0b74fe315" ], - "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff", - "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab" + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff" } } } - } + }, + "operationId": "AuthorizationAccessPolicy_Get", + "title": "ApiManagementGetAuthorizationAccessPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationLoginRequest.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationLoginRequest.json index e8c3905088c6..654fb0ba71f6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationLoginRequest.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationLoginRequest.json @@ -1,14 +1,14 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "authorizationProviderId": "aadwithauthcode", "authorizationId": "authz1", + "authorizationProviderId": "aadwithauthcode", "parameters": { "postLoginRedirectUrl": "https://www.bing.com/" - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -16,5 +16,7 @@ "loginLink": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1/login?data=eyJMb2dpbklkIjoiY2YtODNmYzQ5N2YyZWYxNDA4MzlmNDdjZDU3YWY3MmZmODctYW5nYW50aS1wcmV2aWV3X2FhZC1hdXRoY29kZV9vYXV0aDItY29kZV90b2tlbiIsIlNlc3Npb25JZCI6IiIsIkxvZ0Nvbm5lY3Rpb25JZCI6ImF1dGh6MiIsIkxvZ0Nvbm5lY3RvcklkIjoiYWFkLWF1dGhjb2RlIiwiTG9nRW52aXJvbm1lbnRJZCI6ImFuZ2FudGktcHJld" } } - } + }, + "operationId": "AuthorizationLoginLinks_Post", + "title": "ApiManagementGetAuthorizationLoginRequest" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationProvider.json index 8204d7ccc9f7..a37789677c05 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationProvider.json @@ -1,34 +1,36 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "authorizationProviderId": "aadwithauthcode" + "authorizationProviderId": "aadwithauthcode", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", - "type": "Microsoft.ApiManagement/service/authorizationProviders", "name": "aadwithauthcode", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", "properties": { "displayName": "aadwithauthcode", "identityProvider": "aad", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "authorizationCode": { "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d", - "scopes": "User.Read.All Group.Read.All", "loginUri": "https://login.windows.net", "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All", "tenantId": "common" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } } } - } + }, + "operationId": "AuthorizationProvider_Get", + "title": "ApiManagementGetAuthorizationProvider" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationServer.json index 4c60d57c5d8a..bb024a0f8117 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationServer.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetAuthorizationServer.json @@ -1,45 +1,47 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "authsid": "newauthServer2" + "authsid": "newauthServer2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer2", - "type": "Microsoft.ApiManagement/service/authorizationServers", "name": "newauthServer2", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer2", "properties": { - "displayName": "test3", - "useInTestConsole": false, - "useInApiDocumentation": true, "description": "test server", - "clientRegistrationEndpoint": "https://www.contoso.com/apps", "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", "authorizationMethods": [ "GET" ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], "clientAuthenticationMethod": [ "Basic" ], - "tokenEndpoint": "https://www.contoso.com/oauth2/token", - "supportState": true, + "clientId": "1", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", "defaultScope": "read write", + "displayName": "test3", "grantTypes": [ "authorizationCode", "implicit" ], - "bearerTokenSendingMethods": [ - "authorizationHeader" - ], - "clientId": "1", + "resourceOwnerPassword": "pwd", "resourceOwnerUsername": "un", - "resourceOwnerPassword": "pwd" + "supportState": true, + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "useInApiDocumentation": true, + "useInTestConsole": false } } } - } + }, + "operationId": "AuthorizationServer_Get", + "title": "ApiManagementGetAuthorizationServer" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetBackend.json index e87a08aa9bca..9bd27e7766c7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetBackend.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetBackend.json @@ -1,38 +1,40 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "backendId": "sfbackend" + "backendId": "sfbackend", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", - "type": "Microsoft.ApiManagement/service/backends", "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", "properties": { "description": "Service Fabric Test App 1", - "url": "fabric:/mytestapp/mytestservice", - "protocol": "http", "properties": { "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", "managementEndpoints": [ "https://somecluster.com" ], - "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "maxPartitionResolutionRetries": 5, "serverX509Names": [ { "name": "ServerCommonName1", "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" } - ], - "maxPartitionResolutionRetries": 5 + ] } - } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" } } } - } + }, + "operationId": "Backend_Get", + "title": "ApiManagementGetBackend" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetCache.json index 87e2a1b49184..ee929ec16ec6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetCache.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetCache.json @@ -1,24 +1,26 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "cacheId": "c1" + "cacheId": "c1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", - "type": "Microsoft.ApiManagement/service/caches", "name": "c1", + "type": "Microsoft.ApiManagement/service/caches", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", "properties": { - "useFromLocation": "default", "description": "Redis cache instances in West India", "connectionString": "{{5f7fbca77a891a2200f3db38}}", - "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1" + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1", + "useFromLocation": "default" } } } - } + }, + "operationId": "Cache_Get", + "title": "ApiManagementGetCache" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetCertificate.json index fba649cce3ad..41aa7dfefc21 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetCertificate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetCertificate.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "certificateId": "templateCert1" + "certificateId": "templateCert1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCert1", - "type": "Microsoft.ApiManagement/service/certificates", "name": "templateCert1", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCert1", "properties": { + "expirationDate": "2017-04-23T17:03:41Z", "subject": "CN=mutual-authcert", - "thumbprint": "EBA**********************8594A6", - "expirationDate": "2017-04-23T17:03:41Z" + "thumbprint": "EBA**********************8594A6" } } } - } + }, + "operationId": "Certificate_Get", + "title": "ApiManagementGetCertificate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetCertificateWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetCertificateWithKeyVault.json index c3a1edea8a82..08f9eecca138 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetCertificateWithKeyVault.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetCertificateWithKeyVault.json @@ -1,31 +1,33 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "certificateId": "templateCertkv" + "certificateId": "templateCertkv", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", - "type": "Microsoft.ApiManagement/service/certificates", "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", "properties": { - "subject": "CN=*.msitesting.net", - "thumbprint": "EA**********************9AD690", "expirationDate": "2037-01-01T07:00:00Z", "keyVault": { - "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-22T00:24:53.3191468Z" - } - } + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" } } } - } + }, + "operationId": "Certificate_Get", + "title": "ApiManagementGetCertificateWithKeyVault" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetClientApplication.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetClientApplication.json index fc78096c6cb7..c4a9062c12d9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetClientApplication.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetClientApplication.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "clientApplicationId": "testAppId" + "clientApplicationId": "testAppId", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId", - "type": "Microsoft.ApiManagement/service/clientApplications", "name": "testAppId", + "type": "Microsoft.ApiManagement/service/clientApplications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId", "properties": { - "displayName": "Test Application", - "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId", - "state": "active", "description": "This is just an example application", + "displayName": "Test Application", "entraApplicationId": "00000000-0000-0000-0000-000000000000", - "entraTenantId": "00000000-0000-0000-0000-000000000000" + "entraTenantId": "00000000-0000-0000-0000-000000000000", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId", + "state": "active" } } } - } + }, + "operationId": "ClientApplication_Get", + "title": "ApiManagementGetClientApplication" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetClientApplicationProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetClientApplicationProductLink.json index 6684c4bc8461..379672665b44 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetClientApplicationProductLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetClientApplicationProductLink.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "clientApplicationId": "testAppId", - "clientApplicationProductLinkId": "link1" + "clientApplicationProductLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link1", - "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link1", "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter" } } } - } + }, + "operationId": "ClientApplicationProductLink_Get", + "title": "ApiManagementGetProductApiLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetContentType.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetContentType.json index 41e5ddce7fed..8ebab1602df2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetContentType.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetContentType.json @@ -1,68 +1,70 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "contentTypeId": "page" + "contentTypeId": "page", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/contentTypes/page", - "type": "Microsoft.ApiManagement/service/contentTypes", "name": "page", + "type": "Microsoft.ApiManagement/service/contentTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/contentTypes/page", "properties": { "name": "Page", - "description": "A regular page", "schema": { + "additionalProperties": false, "properties": { "en_us": { "type": "object", + "additionalProperties": false, "properties": { - "title": { - "title": "Title", - "description": "Page title. This property gets included in SEO attributes.", - "type": "string", - "indexed": true - }, "description": { - "title": "Description", + "type": "string", "description": "Page description. This property gets included in SEO attributes.", + "indexed": true, + "title": "Description" + }, + "documentId": { "type": "string", - "indexed": true + "description": "Reference to page content document.", + "title": "Document ID" }, "keywords": { - "title": "Keywords", - "description": "Page keywords. This property gets included in SEO attributes.", "type": "string", - "indexed": true + "description": "Page keywords. This property gets included in SEO attributes.", + "indexed": true, + "title": "Keywords" }, "permalink": { - "title": "Permalink", - "description": "Page permalink, e.g. '/about'.", "type": "string", - "indexed": true + "description": "Page permalink, e.g. '/about'.", + "indexed": true, + "title": "Permalink" }, - "documentId": { - "title": "Document ID", - "description": "Reference to page content document.", - "type": "string" + "title": { + "type": "string", + "description": "Page title. This property gets included in SEO attributes.", + "indexed": true, + "title": "Title" } }, - "additionalProperties": false, "required": [ "title", "permalink", "documentId" ] } - }, - "additionalProperties": false + } }, + "description": "A regular page", "version": "1.0.0" } } } - } + }, + "operationId": "ContentType_Get", + "title": "ApiManagementGetContentType" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetContentTypeContentItem.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetContentTypeContentItem.json index a8c136d76244..506cb91494a6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetContentTypeContentItem.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetContentTypeContentItem.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", "contentTypeId": "page", - "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", - "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", "name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", "properties": { "en_us": { - "title": "About", "description": "Short story about the company.", - "keywords": "company, about", "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", - "permalink": "/about" + "keywords": "company, about", + "permalink": "/about", + "title": "About" } } } } - } + }, + "operationId": "ContentItem_Get", + "title": "ApiManagementGetContentTypeContentItem" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetDeletedServiceByName.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetDeletedServiceByName.json index 938113cf3d20..dc7057c734a0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetDeletedServiceByName.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetDeletedServiceByName.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService3", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "location": "westus" + "location": "westus", + "serviceName": "apimService3", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3", "name": "apimService3", "type": "Microsoft.ApiManagement/deletedservices", + "id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3", "location": "West US", "properties": { - "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3", + "deletionDate": "2017-05-27T15:33:55.5426123Z", "scheduledPurgeDate": "2017-05-27T15:33:55.5426123Z", - "deletionDate": "2017-05-27T15:33:55.5426123Z" + "serviceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3" } } } - } + }, + "operationId": "DeletedServices_GetByName", + "title": "ApiManagementGetDeletedServiceByName" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetDiagnostic.json index 187fb9e1bef2..2a1ab770fbe9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetDiagnostic.json @@ -1,56 +1,58 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "diagnosticId": "applicationinsights" + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "httpCorrelationProtocol": "Legacy", - "logClientIp": true, - "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", - "sampling": { - "samplingType": "fixed", - "percentage": 100 - }, - "frontend": { - "request": { - "headers": [], + "backend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } }, - "backend": { - "request": { - "headers": [], + "frontend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" } } } } - } + }, + "operationId": "Diagnostic_Get", + "title": "ApiManagementGetDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetDocumentation.json index 822f6f1c8518..7d9955ea5395 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetDocumentation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetDocumentation.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "documentationId": "57d1f7558aa04f15146d9d8a" + "documentationId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", - "type": "Microsoft.ApiManagement/service/documentations", "name": "57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/documentations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", "properties": { - "title": "Title", - "content": "content" + "content": "content", + "title": "Title" } } } - } + }, + "operationId": "Documentation_Get", + "title": "ApiManagementGetDocumentation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGateway.json index f567973a2aae..e08ea9b9ea15 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGateway.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGateway.json @@ -1,17 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "gatewayId": "gw1" + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", - "type": "Microsoft.ApiManagement/service/gateways", "name": "a1", + "type": "Microsoft.ApiManagement/service/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", "properties": { "description": "my gateway 1", "locationData": { @@ -20,5 +20,7 @@ } } } - } + }, + "operationId": "Gateway_Get", + "title": "ApiManagementGetGateway" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGatewayCertificateAuthority.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGatewayCertificateAuthority.json index d21ad2ac9c20..84144bd9249f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGatewayCertificateAuthority.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGatewayCertificateAuthority.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "certificateId": "cert1", "gatewayId": "gw1", - "certificateId": "cert1" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", - "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", "name": "cert1", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", "properties": { "isTrusted": true } } } - } + }, + "operationId": "GatewayCertificateAuthority_Get", + "title": "ApiManagementGetGatewayCertificateAuthority" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGatewayConfigConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGatewayConfigConnection.json index 0aa38508e218..946ffeeee182 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGatewayConfigConnection.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGatewayConfigConnection.json @@ -1,24 +1,26 @@ { "parameters": { - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "configConnectionName": "gcc-01", "gatewayName": "standard-gw-01", - "configConnectionName": "gcc-01" + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", "name": "gcc-1", "type": "Microsoft.ApiManagement/gateways/configConnections", "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", "properties": { + "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net", "provisioningState": "Succeeded", - "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001", - "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net" + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001" } } } - } + }, + "operationId": "ApiGatewayConfigConnection_Get", + "title": "ApiManagementGetGatewayConfigConnection" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGatewayHostnameConfiguration.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGatewayHostnameConfiguration.json index 207d02bca1f7..98166f545b50 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGatewayHostnameConfiguration.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGatewayHostnameConfiguration.json @@ -1,24 +1,26 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "gatewayId": "gw1", - "hcId": "default" + "hcId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", - "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", "name": "default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", "properties": { - "hostname": "*", "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "hostname": "*", "negotiateClientCertificate": false } } } - } + }, + "operationId": "GatewayHostnameConfiguration_Get", + "title": "ApiManagementGetGatewayHostnameConfiguration" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGlobalSchema1.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGlobalSchema1.json index e0392844e6ee..7d7eae1fdc97 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGlobalSchema1.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGlobalSchema1.json @@ -1,17 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "schemaId": "schema1" + "resourceGroupName": "rg1", + "schemaId": "schema1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", - "type": "Microsoft.ApiManagement/service/schemas", "name": "schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", "properties": { "description": "sample schema description", "schemaType": "xml", @@ -19,5 +19,7 @@ } } } - } + }, + "operationId": "GlobalSchema_Get", + "title": "ApiManagementGetSchema1" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGlobalSchema2.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGlobalSchema2.json index f7721a6993c0..38b94b5c64b0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGlobalSchema2.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGlobalSchema2.json @@ -1,26 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "schemaId": "schema2" + "resourceGroupName": "rg1", + "schemaId": "schema2", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema2", - "type": "Microsoft.ApiManagement/service/schemas", "name": "schema2", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema2", "properties": { "description": "sample schema description", - "schemaType": "json", "document": { + "type": "object", "$id": "https://example.com/person.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "Person", - "type": "object", "properties": { + "age": { + "type": "integer", + "description": "Age in years which must be equal to or greater than zero.", + "minimum": 0 + }, "firstName": { "type": "string", "description": "The person's first name." @@ -28,16 +31,15 @@ "lastName": { "type": "string", "description": "The person's last name." - }, - "age": { - "description": "Age in years which must be equal to or greater than zero.", - "type": "integer", - "minimum": 0 } - } - } + }, + "title": "Person" + }, + "schemaType": "json" } } } - } + }, + "operationId": "GlobalSchema_Get", + "title": "ApiManagementGetSchema2" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGraphQLApiResolver.json index 2c5c38888325..c418eaaffb58 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGraphQLApiResolver.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGraphQLApiResolver.json @@ -1,24 +1,26 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", - "resolverId": "57d2ef278aa04f0ad01d6cdc" + "resolverId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/apis/resolvers", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc", "properties": { - "displayName": "Query Users", "path": "Query/users", - "description": "A GraphQL Resolver example" + "description": "A GraphQL Resolver example", + "displayName": "Query Users" } } } - } + }, + "operationId": "GraphQLApiResolver_Get", + "title": "ApiManagementGetGraphQLApiResolver" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGraphQLApiResolverPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGraphQLApiResolverPolicy.json index b964b04bef6c..54f490aaed44 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGraphQLApiResolverPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGraphQLApiResolverPolicy.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "5600b539c53f5b0062040001", + "policyId": "policy", "resolverId": "5600b53ac53f5b0062080006", - "policyId": "policy" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/resolvers/5600b53ac53f5b0062080006/policies/policy", - "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/resolvers/5600b53ac53f5b0062080006/policies/policy", "properties": { "value": "\r\n \r\n GET\r\n\r\n/api/users\r\n\r\n" } } } - } + }, + "operationId": "GraphQLApiResolverPolicy_Get", + "title": "ApiManagementGetGraphQLApiResolverPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGroup.json index b002f0e23dfc..c8c49ffedb0e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetGroup.json @@ -1,25 +1,27 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "groupId": "59306a29e4bbd510dc24e5f9" + "groupId": "59306a29e4bbd510dc24e5f9", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9", - "type": "Microsoft.ApiManagement/service/groups", "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9", "properties": { - "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "type": "external", "description": "awesome group of people", "builtIn": false, - "type": "external", + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" } } } - } + }, + "operationId": "Group_Get", + "title": "ApiManagementGetGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetIdentityProvider.json index 4228f066a9f9..fc5a6865748c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetIdentityProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetIdentityProvider.json @@ -1,30 +1,32 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "identityProviderName": "aadB2C" + "identityProviderName": "aadB2C", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C", - "type": "Microsoft.ApiManagement/service/identityProviders", "name": "AadB2C", + "type": "Microsoft.ApiManagement/service/identityProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C", "properties": { - "clientId": "f02dafe2-b8b8-48ec-a38e-27e5c16c51e5", "type": "aadB2C", - "authority": "login.microsoftonline.com", - "signinTenant": "contosoaadb2c.onmicrosoft.com", "allowedTenants": [ "contosoaadb2c.onmicrosoft.com", "contoso2aadb2c.onmicrosoft.com" ], - "signupPolicyName": "B2C_1_policy-signup", - "signinPolicyName": "B2C_1_policy-signin" + "authority": "login.microsoftonline.com", + "clientId": "f02dafe2-b8b8-48ec-a38e-27e5c16c51e5", + "signinPolicyName": "B2C_1_policy-signin", + "signinTenant": "contosoaadb2c.onmicrosoft.com", + "signupPolicyName": "B2C_1_policy-signup" } } } - } + }, + "operationId": "IdentityProvider_Get", + "title": "ApiManagementGetIdentityProvider" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetIssue.json index 203ad93e15e4..bfbdada4e856 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetIssue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetIssue.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "issueId": "57d2ef278aa04f0ad01d6cdc" + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/issues", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/issues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues/57d2ef278aa04f0ad01d6cdc", "properties": { - "title": "New API issue", "description": "New API issue description", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", "createdDate": "2018-02-01T22:21:20.467Z", "state": "open", - "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", - "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a" + "title": "New API issue", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" } } } - } + }, + "operationId": "Issue_Get", + "title": "ApiManagementGetIssue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetLogger.json index a3b6b053a762..1cf3bd1c982f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetLogger.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetLogger.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "loggerId": "templateLogger" + "loggerId": "templateLogger", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/kloudapilogger1", - "type": "Microsoft.ApiManagement/service/loggers", "name": "kloudapilogger1", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/kloudapilogger1", "properties": { - "loggerType": "azureEventHub", "description": "testeventhub3again", "credentials": { "name": "testeventhub4", "connectionString": "Endpoint=sb://eventhubapim.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=************" }, "isBuffered": true, + "loggerType": "azureEventHub", "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/eventhubapim" } } } - } + }, + "operationId": "Logger_Get", + "title": "ApiManagementGetLogger" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetNamedValue.json index 241de4cd1411..508c86f9eb53 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetNamedValue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetNamedValue.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "namedValueId": "testarmTemplateproperties2" + "namedValueId": "testarmTemplateproperties2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testarmTemplateproperties2", - "type": "Microsoft.ApiManagement/service/namedValues", "name": "testarmTemplateproperties2", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testarmTemplateproperties2", "properties": { "displayName": "propName", - "value": "propValue", + "secret": false, "tags": [ "foo", "bar" ], - "secret": false + "value": "propValue" } } } - } + }, + "operationId": "NamedValue_Get", + "title": "ApiManagementGetNamedValue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetNamedValueWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetNamedValueWithKeyVault.json index 71fe6177d81c..49faac881824 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetNamedValueWithKeyVault.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetNamedValueWithKeyVault.json @@ -1,34 +1,36 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "namedValueId": "testprop6" + "namedValueId": "testprop6", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", - "type": "Microsoft.ApiManagement/service/namedValues", "name": "testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", "properties": { "displayName": "prop6namekv", "keyVault": { - "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-11T00:54:31.8024882Z" - } + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" }, + "secret": true, "tags": [ "foo", "bar" - ], - "secret": true + ] } } } - } + }, + "operationId": "NamedValue_Get", + "title": "ApiManagementGetNamedValueWithKeyVault" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetNotification.json index 883188d3315b..8b4c4633357a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetNotification.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetNotification.json @@ -1,19 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "notificationName": "RequestPublisherNotificationMessage" + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", - "type": "Microsoft.ApiManagement/service/notifications", "name": "RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", "properties": { - "title": "Subscription requests (requiring approval)", "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", "recipients": { "emails": [ @@ -24,9 +23,12 @@ "users": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" ] - } + }, + "title": "Subscription requests (requiring approval)" } } } - } + }, + "operationId": "Notification_Get", + "title": "ApiManagementGetNotification" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json index 76a9f110327c..86d5df11821a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "opid": "templateOpenIdConnect2" + "opid": "templateOpenIdConnect2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", - "type": "Microsoft.ApiManagement/service/openidconnectproviders", "name": "templateOpenIdConnect2", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", "properties": { - "displayName": "templateoidprovider2", "description": "open id provider template2", - "metadataEndpoint": "https://oidprovider-template2.net", "clientId": "oidprovidertemplate2", - "useInTestConsole": false, - "useInApiDocumentation": true + "displayName": "templateoidprovider2", + "metadataEndpoint": "https://oidprovider-template2.net", + "useInApiDocumentation": true, + "useInTestConsole": false } } } - } + }, + "operationId": "OpenIdConnectProvider_Get", + "title": "ApiManagementGetOpenIdConnectProvider" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetOperationResult.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetOperationResult.json index 79d8b858547a..2604e31609d9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetOperationResult.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetOperationResult.json @@ -1,9 +1,9 @@ { "parameters": { - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "operationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", - "location": "westus2" + "api-version": "2024-10-01-preview", + "location": "westus2", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {}, @@ -12,5 +12,7 @@ "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ApiManagement/locations/westus2/operationResults/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx?api-version=2024-10-01-preview" } } - } + }, + "operationId": "OperationsResults_Get", + "title": "ApiManagementGetOperationResult" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetOperationStatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetOperationStatus.json index 7453463f30bc..a3acd59e3c33 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetOperationStatus.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetOperationStatus.json @@ -1,9 +1,9 @@ { "parameters": { - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "operationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", - "location": "testLocation" + "api-version": "2024-10-01-preview", + "location": "testLocation", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -11,5 +11,7 @@ "status": "InProgress" } } - } + }, + "operationId": "OperationStatus_Get", + "title": "Get operation status" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicy.json index 5fe3e7942fed..915ed286b10d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicy.json @@ -1,21 +1,23 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "policyId": "policy" + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", - "type": "Microsoft.ApiManagement/service/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", "properties": { "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "Policy_Get", + "title": "ApiManagementGetPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyFormat.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyFormat.json index 68bd5a357f95..7ee42c0b4d5b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyFormat.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyFormat.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "format": "rawxml", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "policyId": "policy", - "format": "rawxml" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", - "type": "Microsoft.ApiManagement/service/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", "properties": { "format": "rawxml", "value": "\r\n\r\n\t\r\n\t\t\r\n\t\t\t@{\n var guidBinary = new byte[16];\n Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10);\n long time = DateTime.Now.Ticks;\n byte[] bytes = new byte[6];\n unchecked\n {\n bytes[5] = (byte)(time >> 40);\n bytes[4] = (byte)(time >> 32);\n bytes[3] = (byte)(time >> 24);\n bytes[2] = (byte)(time >> 16);\n bytes[1] = (byte)(time >> 8);\n bytes[0] = (byte)(time);\n }\n Array.Copy(bytes, 0, guidBinary, 10, 6);\n return new Guid(guidBinary).ToString();\n }\n \r\n\t\t\r\n\t\r\n\t\r\n\t\t\r\n\t\r\n\t\r\n\t\r\n" } } } - } + }, + "operationId": "Policy_Get", + "title": "ApiManagementGetPolicyFormat" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyFragment.json index e5edcdbddb38..3eaceed33490 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyFragment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyFragment.json @@ -1,17 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "id": "policyFragment1" + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", - "type": "Microsoft.ApiManagement/service/policyFragments", "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", "properties": { "format": "xml", "description": "A policy fragment example", @@ -19,5 +19,7 @@ } } } - } + }, + "operationId": "PolicyFragment_Get", + "title": "ApiManagementGetPolicyFragment" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyFragmentFormat.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyFragmentFormat.json index be8e0bd03483..0c6a6928e8c9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyFragmentFormat.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyFragmentFormat.json @@ -1,18 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "format": "rawxml", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "id": "policyFragment1", - "format": "rawxml" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", - "type": "Microsoft.ApiManagement/service/policyFragments", "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", "properties": { "format": "rawxml", "description": "A policy fragment example", @@ -20,5 +20,7 @@ } } } - } + }, + "operationId": "PolicyFragment_Get", + "title": "ApiManagementGetPolicyFragmentFormat" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyRestriction.json index f5e4e1ce50e7..90d4522e8a4a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyRestriction.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPolicyRestriction.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "policyRestrictionId": "policyRestriction1" + "policyRestrictionId": "policyRestriction1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", - "type": "Microsoft.ApiManagement/service/policyRestrictions", "name": "policyRestriction1", + "type": "Microsoft.ApiManagement/service/policyRestrictions", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", "properties": { - "scope": "Sample Path to the policy document.", - "requireBase": "true" + "requireBase": "true", + "scope": "Sample Path to the policy document." } } } - } + }, + "operationId": "PolicyRestriction_Get", + "title": "ApiManagementGetPolicyRestriction" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPortalRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPortalRevision.json index a4b6f89d70d7..63f4ae63f167 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPortalRevision.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPortalRevision.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "portalRevisionId": "20201112101010" + "portalRevisionId": "20201112101010", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010", - "type": "Microsoft.ApiManagement/service/portalRevisions", "name": "20201112101010", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010", "properties": { "description": "portal revision 1", - "statusDetails": null, - "status": "completed", - "isCurrent": true, "createdDateTime": "2020-11-12T22:51:36.47Z", + "isCurrent": true, + "status": "completed", + "statusDetails": null, "updatedDateTime": "2020-11-12T22:52:00.097Z" } } } - } + }, + "operationId": "PortalRevision_Get", + "title": "ApiManagementGetPortalRevision" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPrivateEndpointConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPrivateEndpointConnection.json index 41ab58364e12..c5edc12ea05d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPrivateEndpointConnection.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPrivateEndpointConnection.json @@ -1,29 +1,31 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "privateEndpointConnectionName": "privateEndpointConnectionName" + "privateEndpointConnectionName": "privateEndpointConnectionName", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName", - "type": "Microsoft.ApiManagement/service/privateEndpointConnections", "name": "privateEndpointProxyName", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName", "properties": { - "provisioningState": "Pending", "privateEndpoint": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName" }, "privateLinkServiceConnectionState": { - "status": "Pending", "description": "Please approve my request, thanks", - "actionsRequired": "None" - } + "actionsRequired": "None", + "status": "Pending" + }, + "provisioningState": "Pending" } } } - } + }, + "operationId": "PrivateEndpointConnection_GetByName", + "title": "ApiManagementGetPrivateEndpointConnection" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPrivateLinkGroupResource.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPrivateLinkGroupResource.json index e575e4a570b2..80885732818b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPrivateLinkGroupResource.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetPrivateLinkGroupResource.json @@ -1,17 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "privateLinkSubResourceName": "privateLinkSubResourceName" + "privateLinkSubResourceName": "privateLinkSubResourceName", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/Gateway", "name": "Gateway", "type": "Microsoft.ApiManagement/service/privateLinkResources", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/Gateway", "properties": { "groupId": "Gateway", "requiredMembers": [ @@ -23,5 +23,7 @@ } } } - } + }, + "operationId": "PrivateEndpointConnection_GetPrivateLinkResource", + "title": "ApiManagementGetPrivateLinkGroupResource" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProduct.json index 40e76b500125..b0dc9ad1003f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProduct.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "unlimited" + "productId": "unlimited", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited", - "type": "Microsoft.ApiManagement/service/products", "name": "unlimited", + "type": "Microsoft.ApiManagement/service/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited", "properties": { - "displayName": "Unlimited", "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", - "subscriptionRequired": true, "approvalRequired": true, - "subscriptionsLimit": 1, - "state": "published" + "displayName": "Unlimited", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1 } } } - } + }, + "operationId": "Product_Get", + "title": "ApiManagementGetProduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductApiLink.json index a9e314f1f7a4..05303b6d22a1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductApiLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductApiLink.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiLinkId": "link1", "productId": "testproduct", - "apiLinkId": "link1" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/products/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" } } } - } + }, + "operationId": "ProductApiLink_Get", + "title": "ApiManagementGetProductApiLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductGroupLink.json index 09a5270a7b38..49e280fd833d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductGroupLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductGroupLink.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupLinkId": "link1", "productId": "testproduct", - "groupLinkId": "link1" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groupLinks/link1", - "type": "Microsoft.ApiManagement/service/products/groupLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/products/groupLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/groupLinks/link1", "properties": { "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" } } } - } + }, + "operationId": "ProductGroupLink_Get", + "title": "ApiManagementGetProductGroupLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductPolicy.json index 88256b4a89a2..f11cda581d06 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductPolicy.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyId": "policy", "productId": "kjoshiarmTemplateProduct4", - "policyId": "policy" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmTemplateProduct4/policies/policy", - "type": "Microsoft.ApiManagement/service/products/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmTemplateProduct4/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "ProductPolicy_Get", + "title": "ApiManagementGetProductPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductTag.json index 93357cfe8d57..67f660fb28bc 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductTag.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "productId": "59d6bb8f1f7fab13dc67ec9b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagId": "59306a29e4bbd510dc24e5f9" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", - "type": "Microsoft.ApiManagement/service/tags", "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", "properties": { "displayName": "tag1" } } } - } + }, + "operationId": "Tag_GetByProduct", + "title": "ApiManagementGetProductTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductWiki.json index ea3d7020c503..86482bcf1f4c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductWiki.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetProductWiki.json @@ -1,17 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "57d1f7558aa04f15146d9d8a" + "productId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", - "type": "Microsoft.ApiManagement/service/products/wikis", "name": "default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", "properties": { "documents": [ { @@ -24,5 +24,7 @@ } } } - } + }, + "operationId": "ProductWiki_Get", + "title": "ApiManagementGetProductWiki" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetQuotaCounterKeys.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetQuotaCounterKeys.json index 5daa901d2d23..85eb76ac2b4c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetQuotaCounterKeys.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetQuotaCounterKeys.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "quotaCounterKey": "ba" + "quotaCounterKey": "ba", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { "counterKey": "ba", + "periodEndTime": "2018-02-08T16:54:40Z", "periodKey": "0_P3Y6M4DT12H30M5S", "periodStartTime": "2014-08-04T04:24:35Z", - "periodEndTime": "2018-02-08T16:54:40Z", "value": { "callsCount": 5, "kbTransferred": 2.5830078125 } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "QuotaByCounterKeys_ListByService", + "title": "ApiManagementGetQuotaCounterKeys" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json index 07c831e5dbfa..2ef704a06c37 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json @@ -1,24 +1,26 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "quotaCounterKey": "ba", - "quotaPeriodKey": "0_P3Y6M4DT12H30M5S" + "quotaPeriodKey": "0_P3Y6M4DT12H30M5S", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "counterKey": "ba", + "periodEndTime": "2018-02-08T16:54:40Z", "periodKey": "0_P3Y6M4DT12H30M5S", "periodStartTime": "2014-08-04T04:24:35Z", - "periodEndTime": "2018-02-08T16:54:40Z", "value": { "callsCount": 0, "kbTransferred": 2.5625 } } } - } + }, + "operationId": "QuotaByPeriodKeys_Get", + "title": "ApiManagementGetQuotaCounterKeysByQuotaPeriod" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByApi.json index a30ff74fed05..7ec95bfcb564 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByApi.json @@ -1,55 +1,57 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { "name": "Echo API", "apiId": "/apis/5600b59475ff190048040001", - "callCountSuccess": 0, + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 0, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 0, "callCountTotal": 0, - "bandwidth": 0, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 0, - "apiTimeMin": 0, - "apiTimeMax": 0, "serviceTimeAvg": 0, - "serviceTimeMin": 0, - "serviceTimeMax": 0 + "serviceTimeMax": 0, + "serviceTimeMin": 0 }, { "name": "httpbin", "apiId": "/apis/57a03a13e4bbd5119c8b19e9", - "callCountSuccess": 13, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMax": 1819.2173, + "apiTimeMin": 330.3206, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 1, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 13, "callCountTotal": 14, - "bandwidth": 11019, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 1015.7607923076923, - "apiTimeMin": 330.3206, - "apiTimeMax": 1819.2173, "serviceTimeAvg": 957.094776923077, - "serviceTimeMin": 215.24, - "serviceTimeMax": 1697.3612 + "serviceTimeMax": 1697.3612, + "serviceTimeMin": 215.24 } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "Reports_ListByApi", + "title": "ApiManagementGetReportsByApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByGeo.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByGeo.json index efda2f2f7a93..fe6abb3629a4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByGeo.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByGeo.json @@ -1,37 +1,39 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "country": "US", - "region": "WA", - "zip": "98052", - "callCountSuccess": 13, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMax": 1819.2173, + "apiTimeMin": 330.3206, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 1, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 13, "callCountTotal": 14, - "bandwidth": 11019, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 1015.7607923076923, - "apiTimeMin": 330.3206, - "apiTimeMax": 1819.2173, + "country": "US", + "region": "WA", "serviceTimeAvg": 957.094776923077, + "serviceTimeMax": 1697.3612, "serviceTimeMin": 215.24, - "serviceTimeMax": 1697.3612 + "zip": "98052" } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "Reports_ListByGeo", + "title": "ApiManagementGetReportsByGeo" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByOperation.json index acb0a8d50a00..28feef4d1cd3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByOperation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByOperation.json @@ -1,76 +1,78 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { "name": "get", - "apiId": "/apis/57a03a13e4bbd5119c8b19e9", "operationId": "/apis/57a03a13e4bbd5119c8b19e9/operations/57a03a1dd8d14f0a780d7d14", - "callCountSuccess": 13, + "apiId": "/apis/57a03a13e4bbd5119c8b19e9", + "apiTimeAvg": 1015.7607923076923, + "apiTimeMax": 1819.2173, + "apiTimeMin": 330.3206, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 1, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 13, "callCountTotal": 14, - "bandwidth": 11019, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 1015.7607923076923, - "apiTimeMin": 330.3206, - "apiTimeMax": 1819.2173, "serviceTimeAvg": 957.094776923077, - "serviceTimeMin": 215.24, - "serviceTimeMax": 1697.3612 + "serviceTimeMax": 1697.3612, + "serviceTimeMin": 215.24 }, { "name": "GetWeatherInformation", - "apiId": "/apis/57c999d1e4bbd50c988cb2c3", "operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93e", - "callCountSuccess": 0, + "apiId": "/apis/57c999d1e4bbd50c988cb2c3", + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 0, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 0, "callCountTotal": 0, - "bandwidth": 0, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 0, - "apiTimeMin": 0, - "apiTimeMax": 0, "serviceTimeAvg": 0, - "serviceTimeMin": 0, - "serviceTimeMax": 0 + "serviceTimeMax": 0, + "serviceTimeMin": 0 }, { "name": "GetCityForecastByZIP", - "apiId": "/apis/57c999d1e4bbd50c988cb2c3", "operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93f", - "callCountSuccess": 0, + "apiId": "/apis/57c999d1e4bbd50c988cb2c3", + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 0, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 0, "callCountTotal": 0, - "bandwidth": 0, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 0, - "apiTimeMin": 0, - "apiTimeMax": 0, "serviceTimeAvg": 0, - "serviceTimeMin": 0, - "serviceTimeMax": 0 + "serviceTimeMax": 0, + "serviceTimeMin": 0 } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "Reports_ListByOperation", + "title": "ApiManagementGetReportsByOperation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByProduct.json index e3fc67065540..de3af4f4a9a0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByProduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByProduct.json @@ -1,55 +1,57 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { "name": "Starter", - "productId": "/products/5600b59475ff190048060001", - "callCountSuccess": 0, + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 0, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 0, "callCountTotal": 0, - "bandwidth": 0, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 0, - "apiTimeMin": 0, - "apiTimeMax": 0, + "productId": "/products/5600b59475ff190048060001", "serviceTimeAvg": 0, - "serviceTimeMin": 0, - "serviceTimeMax": 0 + "serviceTimeMax": 0, + "serviceTimeMin": 0 }, { "name": "Unlimited", - "productId": "/products/5600b59475ff190048060002", - "callCountSuccess": 13, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMax": 1819.2173, + "apiTimeMin": 330.3206, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 1, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 13, "callCountTotal": 14, - "bandwidth": 11019, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 1015.7607923076923, - "apiTimeMin": 330.3206, - "apiTimeMax": 1819.2173, + "productId": "/products/5600b59475ff190048060002", "serviceTimeAvg": 957.094776923077, - "serviceTimeMin": 215.24, - "serviceTimeMax": 1697.3612 + "serviceTimeMax": 1697.3612, + "serviceTimeMin": 215.24 } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "Reports_ListByProduct", + "title": "ApiManagementGetReportsByProduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByRequest.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByRequest.json index f45f8bb555d2..a2094623f348 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByRequest.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByRequest.json @@ -1,56 +1,58 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 2, "value": [ { - "apiId": "/apis/5931a75ae4bbd512a88c680b", "operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-", - "productId": "/products/-", - "userId": "/users/1", "method": "GET", - "url": "https://apimService1.azure-api.net/echo/resource?param1=sample", + "apiId": "/apis/5931a75ae4bbd512a88c680b", + "apiRegion": "East Asia", + "apiTime": 221.1544, + "cache": "none", "ipAddress": "207.xx.155.xx", + "productId": "/products/-", + "requestId": "63e7119c-26aa-433c-96d7-f6f3267ff52f", + "requestSize": 0, "responseCode": 404, "responseSize": 405, - "timestamp": "2017-06-03T00:17:00.1649134Z", - "cache": "none", - "apiTime": 221.1544, - "serviceTime": 0.0, - "apiRegion": "East Asia", + "serviceTime": 0, "subscriptionId": "/subscriptions/5600b59475ff190048070002", - "requestId": "63e7119c-26aa-433c-96d7-f6f3267ff52f", - "requestSize": 0 + "timestamp": "2017-06-03T00:17:00.1649134Z", + "url": "https://apimService1.azure-api.net/echo/resource?param1=sample", + "userId": "/users/1" }, { - "apiId": "/apis/5931a75ae4bbd512a88c680b", "operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-", - "productId": "/products/-", - "userId": "/users/1", "method": "POST", - "url": "https://apimService1.azure-api.net/echo/resource", + "apiId": "/apis/5931a75ae4bbd512a88c680b", + "apiRegion": "East Asia", + "apiTime": 6.675400000000001, + "cache": "none", "ipAddress": "207.xx.155.xx", + "productId": "/products/-", + "requestId": "e581b7f7-c9ec-4fc6-8ab9-3855d9b00b04", + "requestSize": 0, "responseCode": 404, "responseSize": 403, - "timestamp": "2017-06-03T00:17:20.5255131Z", - "cache": "none", - "apiTime": 6.6754000000000007, - "serviceTime": 0.0, - "apiRegion": "East Asia", + "serviceTime": 0, "subscriptionId": "/subscriptions/5600b59475ff190048070002", - "requestId": "e581b7f7-c9ec-4fc6-8ab9-3855d9b00b04", - "requestSize": 0 + "timestamp": "2017-06-03T00:17:20.5255131Z", + "url": "https://apimService1.azure-api.net/echo/resource", + "userId": "/users/1" } - ], - "count": 2 + ] } } - } + }, + "operationId": "Reports_ListByRequest", + "title": "ApiManagementGetReportsByRequest" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsBySubscription.json index c79e05e87e0a..e15d3165d751 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsBySubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsBySubscription.json @@ -1,79 +1,81 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { "name": "", - "userId": "/users/1", - "productId": "/products/5600b59475ff190048060001", - "subscriptionId": "/subscriptions/5600b59475ff190048070001", - "callCountSuccess": 0, + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 0, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 0, "callCountTotal": 0, - "bandwidth": 0, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 0, - "apiTimeMin": 0, - "apiTimeMax": 0, + "productId": "/products/5600b59475ff190048060001", "serviceTimeAvg": 0, + "serviceTimeMax": 0, "serviceTimeMin": 0, - "serviceTimeMax": 0 + "subscriptionId": "/subscriptions/5600b59475ff190048070001", + "userId": "/users/1" }, { "name": "", - "userId": "/users/1", - "productId": "/products/5600b59475ff190048060002", - "subscriptionId": "/subscriptions/5600b59475ff190048070002", - "callCountSuccess": 13, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMax": 1819.2173, + "apiTimeMin": 330.3206, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 1, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 13, "callCountTotal": 14, - "bandwidth": 11019, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 1015.7607923076923, - "apiTimeMin": 330.3206, - "apiTimeMax": 1819.2173, + "productId": "/products/5600b59475ff190048060002", "serviceTimeAvg": 957.094776923077, + "serviceTimeMax": 1697.3612, "serviceTimeMin": 215.24, - "serviceTimeMax": 1697.3612 + "subscriptionId": "/subscriptions/5600b59475ff190048070002", + "userId": "/users/1" }, { "name": "", - "userId": "/users/1", - "productId": "/products/5702e97e5157a50f48dce801", - "subscriptionId": "/subscriptions/5702e97e5157a50a9c733303", - "callCountSuccess": 0, + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 0, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 0, "callCountTotal": 0, - "bandwidth": 0, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 0, - "apiTimeMin": 0, - "apiTimeMax": 0, + "productId": "/products/5702e97e5157a50f48dce801", "serviceTimeAvg": 0, + "serviceTimeMax": 0, "serviceTimeMin": 0, - "serviceTimeMax": 0 + "subscriptionId": "/subscriptions/5702e97e5157a50a9c733303", + "userId": "/users/1" } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "Reports_ListBySubscription", + "title": "ApiManagementGetReportsBySubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByTime.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByTime.json index 33964544089a..473969705f96 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByTime.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByTime.json @@ -1,56 +1,58 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", - "interval": "PT15M" + "api-version": "2024-10-01-preview", + "interval": "PT15M", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "timestamp": "2017-06-03T00:15:00Z", - "interval": "PT15M", - "callCountSuccess": 4, + "apiTimeAvg": 1337.46335, + "apiTimeMax": 1819.2173, + "apiTimeMin": 885.0839000000001, + "bandwidth": 3243, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 0, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 4, "callCountTotal": 4, - "bandwidth": 3243, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 1337.46335, - "apiTimeMin": 885.0839000000001, - "apiTimeMax": 1819.2173, + "interval": "PT15M", "serviceTimeAvg": 1255.917425, + "serviceTimeMax": 1697.3612, "serviceTimeMin": 882.8264, - "serviceTimeMax": 1697.3612 + "timestamp": "2017-06-03T00:15:00Z" }, { - "timestamp": "2017-06-03T00:30:00Z", - "interval": "PT15M", - "callCountSuccess": 9, + "apiTimeAvg": 872.7818777777778, + "apiTimeMax": 1093.8407, + "apiTimeMin": 330.3206, + "bandwidth": 7776, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 1, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 9, "callCountTotal": 10, - "bandwidth": 7776, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 872.7818777777778, - "apiTimeMin": 330.3206, - "apiTimeMax": 1093.8407, + "interval": "PT15M", "serviceTimeAvg": 824.2847111111112, + "serviceTimeMax": 973.2262000000001, "serviceTimeMin": 215.24, - "serviceTimeMax": 973.2262000000001 + "timestamp": "2017-06-03T00:30:00Z" } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "Reports_ListByTime", + "title": "ApiManagementGetReportsByTime" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByUser.json index 391f7a9a8de1..0a20768c2fd3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetReportsByUser.json @@ -1,73 +1,75 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { "name": "Administrator", - "userId": "/users/1", - "callCountSuccess": 13, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMax": 1819.2173, + "apiTimeMin": 330.3206, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 1, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 13, "callCountTotal": 14, - "bandwidth": 11019, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 1015.7607923076923, - "apiTimeMin": 330.3206, - "apiTimeMax": 1819.2173, "serviceTimeAvg": 957.094776923077, + "serviceTimeMax": 1697.3612, "serviceTimeMin": 215.24, - "serviceTimeMax": 1697.3612 + "userId": "/users/1" }, { "name": "Samir Solanki", - "userId": "/users/56eaec62baf08b06e46d27fd", - "callCountSuccess": 0, + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 0, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 0, "callCountTotal": 0, - "bandwidth": 0, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 0, - "apiTimeMin": 0, - "apiTimeMax": 0, "serviceTimeAvg": 0, + "serviceTimeMax": 0, "serviceTimeMin": 0, - "serviceTimeMax": 0 + "userId": "/users/56eaec62baf08b06e46d27fd" }, { "name": "Anonymous", - "userId": "/users/54c800b332965a0035030000", - "callCountSuccess": 0, + "apiTimeAvg": 0, + "apiTimeMax": 0, + "apiTimeMin": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, "callCountBlocked": 0, "callCountFailed": 0, "callCountOther": 0, + "callCountSuccess": 0, "callCountTotal": 0, - "bandwidth": 0, - "cacheHitCount": 0, - "cacheMissCount": 0, - "apiTimeAvg": 0, - "apiTimeMin": 0, - "apiTimeMax": 0, "serviceTimeAvg": 0, + "serviceTimeMax": 0, "serviceTimeMin": 0, - "serviceTimeMax": 0 + "userId": "/users/54c800b332965a0035030000" } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "Reports_ListByUser", + "title": "ApiManagementGetReportsByUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetSubscription.json index 0eb8fc2df1e8..8916cb5f4741 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetSubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetSubscription.json @@ -1,25 +1,27 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "sid": "5931a769d8d14f0ad8ce13b8" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "5931a769d8d14f0ad8ce13b8", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8", - "type": "Microsoft.ApiManagement/service/subscriptions", "name": "5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8", "properties": { + "createdDate": "2017-06-02T17:59:06.223Z", + "displayName": "Unlimited", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", - "displayName": "Unlimited", - "state": "submitted", - "createdDate": "2017-06-02T17:59:06.223Z" + "state": "submitted" } } } - } + }, + "operationId": "Subscription_Get", + "title": "ApiManagementGetSubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTag.json index 99c884b9904c..862f52a34927 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTag.json @@ -1,21 +1,23 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagId": "59306a29e4bbd510dc24e5f9" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", - "type": "Microsoft.ApiManagement/service/tags", "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", "properties": { "displayName": "tag1" } } } - } + }, + "operationId": "Tag_Get", + "title": "ApiManagementGetTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTagApiLink.json index 2dcb84541aa7..363f8a1e6525 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTagApiLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTagApiLink.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "tagId": "tag1", - "apiLinkId": "link1" + "tagId": "tag1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/tags/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" } } } - } + }, + "operationId": "TagApiLink_Get", + "title": "ApiManagementGetTagApiLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTagOperationLink.json index 54e5c358647a..852593a39cee 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTagOperationLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTagOperationLink.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "operationLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "tagId": "tag1", - "operationLinkId": "link1" + "tagId": "tag1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", - "type": "Microsoft.ApiManagement/service/tags/operationLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", "properties": { "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" } } } - } + }, + "operationId": "TagOperationLink_Get", + "title": "ApiManagementGetTagOperationLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTagProductLink.json index da7cfddc8aa9..b8498b6cd75f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTagProductLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTagProductLink.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "productLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "tagId": "tag1", - "productLinkId": "link1" + "tagId": "tag1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", - "type": "Microsoft.ApiManagement/service/tags/productLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" } } } - } + }, + "operationId": "TagProductLink_Get", + "title": "ApiManagementGetTagProductLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTemplate.json index f059e759febb..c6bb836b9ab3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTemplate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTemplate.json @@ -1,22 +1,20 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "templateName": "newIssueNotificationMessage" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", - "type": "Microsoft.ApiManagement/service/templates", "name": "NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", "properties": { - "subject": "Your request $IssueName was received", - "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", - "title": "New issue received", "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", "isDefault": true, "parameters": [ { @@ -43,9 +41,13 @@ "name": "DevPortalUrl", "title": "Developer portal URL" } - ] + ], + "subject": "Your request $IssueName was received", + "title": "New issue received" } } } - } + }, + "operationId": "EmailTemplate_Get", + "title": "ApiManagementGetTemplate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTenantAccess.json index bc9516155438..d17ffa05e647 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTenantAccess.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTenantAccess.json @@ -1,21 +1,23 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "accessName": "access", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "accessName": "access" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", - "type": "Microsoft.ApiManagement/service/tenant", "name": "access", + "type": "Microsoft.ApiManagement/service/tenant", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", "properties": { "enabled": true } } } - } + }, + "operationId": "TenantAccess_Get", + "title": "ApiManagementGetTenantAccess" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTenantGitAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTenantGitAccess.json index 3c8ec0d46468..31e29a74f04f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTenantGitAccess.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTenantGitAccess.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "accessName": "gitAccess", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "accessName": "gitAccess" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/gitAccess", - "type": "Microsoft.ApiManagement/service/tenant", "name": "gitAccess", + "type": "Microsoft.ApiManagement/service/tenant", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/gitAccess", "properties": { - "principalId": "git", - "enabled": true + "enabled": true, + "principalId": "git" } } } - } + }, + "operationId": "TenantAccess_Get", + "title": "ApiManagementGetTenantGitAccess" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTenantSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTenantSettings.json index 7d92421a891c..ea8383bf2b7c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTenantSettings.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetTenantSettings.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "settingsType": "public" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "settingsType": "public", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/settings/public", - "type": "Microsoft.ApiManagement/service/settings", "name": "public", + "type": "Microsoft.ApiManagement/service/settings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/settings/public", "properties": { "settings": { - "CustomPortalSettings.UserRegistrationTerms": null, - "CustomPortalSettings.UserRegistrationTermsEnabled": "False", - "CustomPortalSettings.UserRegistrationTermsConsentRequired": "False", + "CustomPortalSettings.DelegatedSubscriptionEnabled": "False", "CustomPortalSettings.DelegationEnabled": "False", "CustomPortalSettings.DelegationUrl": "", - "CustomPortalSettings.DelegatedSubscriptionEnabled": "False" + "CustomPortalSettings.UserRegistrationTerms": null, + "CustomPortalSettings.UserRegistrationTermsConsentRequired": "False", + "CustomPortalSettings.UserRegistrationTermsEnabled": "False" } } } } - } + }, + "operationId": "TenantSettings_Get", + "title": "ApiManagementGetTenantSettings" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetUser.json index 5c35a045691b..2dfb834c80fd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetUser.json @@ -1,31 +1,33 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "userId": "5931a75ae4bbd512a88c680b" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", - "type": "Microsoft.ApiManagement/service/users", "name": "5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", "properties": { - "firstName": "foo", - "lastName": "bar", "email": "foobar@outlook.com", - "state": "active", - "registrationDate": "2017-06-02T17:58:50.357Z", + "firstName": "foo", "identities": [ { - "provider": "Microsoft", - "id": "*************" + "id": "*************", + "provider": "Microsoft" } - ] + ], + "lastName": "bar", + "registrationDate": "2017-06-02T17:58:50.357Z", + "state": "active" } } } - } + }, + "operationId": "User_Get", + "title": "ApiManagementGetUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetUserSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetUserSubscription.json index e1049d7bda14..1aeef14395cd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetUserSubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetUserSubscription.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "5fa9b096f3df14003c070001", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userId": "1", - "sid": "5fa9b096f3df14003c070001" + "userId": "1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1/subscriptions/5fa9b096f3df14003c070001", - "type": "Microsoft.ApiManagement/service/users/subscriptions", "name": "5fa9b096f3df14003c070001", + "type": "Microsoft.ApiManagement/service/users/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1/subscriptions/5fa9b096f3df14003c070001", "properties": { + "allowTracing": true, + "createdDate": "2020-11-09T21:11:50.58Z", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter", - "state": "active", - "createdDate": "2020-11-09T21:11:50.58Z", - "allowTracing": true + "state": "active" } } } - } + }, + "operationId": "UserSubscription_Get", + "title": "ApiManagementGetUserSubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspace.json index 34b825a3d0c1..7c518c715d87 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspace.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspace.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", - "type": "Microsoft.ApiManagement/service/workspaces", "name": "wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", "properties": { "description": "workspace 1", "displayName": "my workspace" } } } - } + }, + "operationId": "Workspace_Get", + "title": "ApiManagementGetWorkspace" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiContract.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiContract.json index 753e508e1011..12b1bfcc032c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiContract.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiContract.json @@ -1,26 +1,22 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "apiId": "57d1f7558aa04f15146d9d8a" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d1f7558aa04f15146d9d8a", - "type": "Microsoft.ApiManagement/service/workspaces/apis", "name": "57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d1f7558aa04f15146d9d8a", "properties": { - "displayName": "Service", - "apiRevision": "1", - "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "type": "soap", "path": "schulte", - "protocols": [ - "https" - ], + "apiRevision": "1", "authenticationSettings": { "oAuth2": { "authorizationServerId": "authorizationServerId2283", @@ -37,15 +33,21 @@ } ] }, + "displayName": "Service", + "isCurrent": true, + "isOnline": true, + "protocols": [ + "https" + ], + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "type": "soap", - "isCurrent": true, - "isOnline": true + } } } } - } + }, + "operationId": "WorkspaceApi_Get", + "title": "ApiManagementGetWorkspaceApiContract" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiDiagnostic.json index 43455f3be6ed..b83a1b7e4248 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiDiagnostic.json @@ -1,58 +1,60 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", + "apiId": "57d1f7558aa04f15146d9d8a", "diagnosticId": "applicationinsights", - "apiId": "57d1f7558aa04f15146d9d8a" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "httpCorrelationProtocol": "Legacy", - "logClientIp": true, - "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", - "sampling": { - "samplingType": "fixed", - "percentage": 100 - }, - "frontend": { - "request": { - "headers": [], + "backend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } }, - "backend": { - "request": { - "headers": [], + "frontend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" } } } } - } + }, + "operationId": "WorkspaceApiDiagnostic_Get", + "title": "ApiManagementGetWorkspaceApiDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi2dot0.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi2dot0.json index 9ffc1f1ce1ac..577193210c2e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi2dot0.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi2dot0.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "format": "swagger-link", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "echo-api", - "format": "swagger-link", - "export": "true" + "export": "true", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api", "format": "swagger-link-json", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api", "value": { "link": "https://apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore Extensive.json?storage-sas-signature" } } } - } + }, + "operationId": "WorkspaceApiExport_Get", + "title": "ApiManagementGetWorkspaceApiExportInOpenApi2dot0" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi3dot0.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi3dot0.json index d6d59069d02e..ec99e5b31994 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi3dot0.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiExportInOpenApi3dot0.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "format": "openapi-link", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "aid9676", - "format": "openapi-link", - "export": "true" + "export": "true", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/aid9676", "format": "openapi-link", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/aid9676", "value": { "link": "https: //apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore.yaml?storage-sas-signature" } } } - } + }, + "operationId": "WorkspaceApiExport_Get", + "title": "ApiManagementGetWorkspaceApiExportInOpenApi3dot0" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiOperation.json index fc3e91bc5da2..8b3f1a5a5884 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiOperation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiOperation.json @@ -1,28 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "57d2ef278aa04f0ad01d6cdc", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "57d2ef278aa04f0888cba3f3", - "operationId": "57d2ef278aa04f0ad01d6cdc" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", "properties": { - "displayName": "CancelOrder", "method": "POST", - "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", + "displayName": "CancelOrder", "templateParameters": [], + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", "request": { "description": "IFazioService_CancelOrder_InputMessage", - "queryParameters": [], "headers": [], + "queryParameters": [], "representations": [ { "contentType": "text/xml", @@ -33,8 +33,8 @@ }, "responses": [ { - "statusCode": 200, "description": "IFazioService_CancelOrder_OutputMessage", + "headers": [], "representations": [ { "contentType": "text/xml", @@ -42,11 +42,13 @@ "typeName": "CancelOrderResponse" } ], - "headers": [] + "statusCode": 200 } ] } } } - } + }, + "operationId": "WorkspaceApiOperation_Get", + "title": "ApiManagementGetWorkspaceApiOperation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiOperationPolicy.json index 26b1caebd334..73fc598fef24 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiOperationPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiOperationPolicy.json @@ -1,24 +1,26 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "5600b53ac53f5b0062080006", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "5600b539c53f5b0062040001", - "operationId": "5600b53ac53f5b0062080006", - "policyId": "policy" + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b539c53f5b0062040001/operations/5600b53ac53f5b0062080006/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b539c53f5b0062040001/operations/5600b53ac53f5b0062080006/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n This is a sample\r\n \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "WorkspaceApiOperationPolicy_Get", + "title": "ApiManagementGetWorkspaceApiOperationPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiPolicy.json index eae70ff1e747..d722cab6cbdb 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiPolicy.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "5600b59475ff190048040001", - "policyId": "policy" + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b59475ff190048040001/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b59475ff190048040001/policies/policy", "properties": { "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "WorkspaceApiPolicy_Get", + "title": "ApiManagementGetWorkspaceApiPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiRelease.json index 6dade62b6150..07647d1170a0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiRelease.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiRelease.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "a1", - "releaseId": "5a7cb545298324c53224a799" + "releaseId": "5a7cb545298324c53224a799", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/5a7cb545298324c53224a799", - "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", "name": "5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/5a7cb545298324c53224a799", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", "createdDateTime": "2018-02-08T20:38:29.173Z", - "updatedDateTime": "2018-02-08T20:38:29.173Z", - "notes": "yahoo" + "notes": "yahoo", + "updatedDateTime": "2018-02-08T20:38:29.173Z" } } } - } + }, + "operationId": "WorkspaceApiRelease_Get", + "title": "ApiManagementGetWorkspaceApiRelease" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiRevision.json index e990da505533..6cae1cd865a1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiRevision.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiRevision.json @@ -1,26 +1,22 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "apiId": "echo-api;rev=3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "apiId": "echo-api;rev=3" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api;rev=3", - "type": "Microsoft.ApiManagement/service/workspaces/apis", "name": "echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api;rev=3", "properties": { - "displayName": "Service", - "apiRevision": "3", - "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", "path": "schulte", - "protocols": [ - "https" - ], + "apiRevision": "3", + "apiRevisionDescription": "fixed bug in contract", "authenticationSettings": { "oAuth2": { "authorizationServerId": "authorizationServerId2283", @@ -37,13 +33,19 @@ } ] }, + "displayName": "Service", + "protocols": [ + "https" + ], + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "apiRevisionDescription": "fixed bug in contract" + } } } } - } + }, + "operationId": "WorkspaceApi_Get", + "title": "ApiManagementGetWorkspaceApiRevision" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiSchema.json index 41da0f8fa220..a8b91130e67d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiSchema.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiSchema.json @@ -1,19 +1,19 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "59d6bb8f1f7fab13dc67ec9b", - "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1" + "resourceGroupName": "rg1", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", - "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", "properties": { "contentType": "application/vnd.ms-azure-apim.xsd+xml", "document": { @@ -22,5 +22,7 @@ } } } - } + }, + "operationId": "WorkspaceApiSchema_Get", + "title": "ApiManagementGetWorkspaceApiSchema" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiVersionSet.json index 7dec60cee7ca..7977880fdbf5 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiVersionSet.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceApiVersionSet.json @@ -1,24 +1,26 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "versionSetId": "vs1" + "versionSetId": "vs1", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs1", - "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", "name": "vs1", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs1", "properties": { + "description": "Version configuration", "displayName": "Version Set 1", - "versioningScheme": "Segment", - "description": "Version configuration" + "versioningScheme": "Segment" } } } - } + }, + "operationId": "WorkspaceApiVersionSet_Get", + "title": "ApiManagementGetWorkspaceApiVersionSet" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceBackend.json index 01d17f9abdc5..15c0ed55cf58 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceBackend.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceBackend.json @@ -1,39 +1,41 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "backendId": "sfbackend", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "backendId": "sfbackend" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", - "type": "Microsoft.ApiManagement/service/workspaces/backends", "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", "properties": { "description": "Service Fabric Test App 1", - "url": "fabric:/mytestapp/mytestservice", - "protocol": "http", "properties": { "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", "managementEndpoints": [ "https://somecluster.com" ], - "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "maxPartitionResolutionRetries": 5, "serverX509Names": [ { "name": "ServerCommonName1", "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" } - ], - "maxPartitionResolutionRetries": 5 + ] } - } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" } } } - } + }, + "operationId": "WorkspaceBackend_Get", + "title": "ApiManagementGetWorkspaceBackend" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceCertificate.json index 9110b4d6d33c..46d113c1c75a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceCertificate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceCertificate.json @@ -1,24 +1,26 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "certificateId": "templateCert1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "certificateId": "templateCert1" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service//workspaces/wks1/certificates/templateCert1", - "type": "Microsoft.ApiManagement/service/workspaces/certificates", "name": "templateCert1", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCert1", "properties": { + "expirationDate": "2017-04-23T17:03:41Z", "subject": "CN=mutual-authcert", - "thumbprint": "EBA**********************8594A6", - "expirationDate": "2017-04-23T17:03:41Z" + "thumbprint": "EBA**********************8594A6" } } } - } + }, + "operationId": "WorkspaceCertificate_Get", + "title": "ApiManagementGetWorkspaceCertificate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceCertificateWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceCertificateWithKeyVault.json index 93cceb586845..d2f2aef75f81 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceCertificateWithKeyVault.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceCertificateWithKeyVault.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "certificateId": "templateCertkv", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "certificateId": "templateCertkv" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", - "type": "Microsoft.ApiManagement/service/workspaces/certificates", "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", "properties": { - "subject": "CN=*.msitesting.net", - "thumbprint": "EA**********************9AD690", "expirationDate": "2037-01-01T07:00:00Z", "keyVault": { - "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-22T00:24:53.3191468Z" - } - } + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" } } } - } + }, + "operationId": "WorkspaceCertificate_Get", + "title": "ApiManagementGetWorkspaceCertificateWithKeyVault" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceDiagnostic.json index 118e939c0d4e..414cde9acd77 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceDiagnostic.json @@ -1,57 +1,59 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "diagnosticId": "applicationinsights" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "httpCorrelationProtocol": "Legacy", - "logClientIp": true, - "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", - "sampling": { - "samplingType": "fixed", - "percentage": 100 - }, - "frontend": { - "request": { - "headers": [], + "backend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } }, - "backend": { - "request": { - "headers": [], + "frontend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" } } } } - } + }, + "operationId": "WorkspaceDiagnostic_Get", + "title": "ApiManagementGetWorkspaceDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceGroup.json index 1b63f2f4781e..afdf753f6088 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceGroup.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "groupId": "59306a29e4bbd510dc24e5f9", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "groupId": "59306a29e4bbd510dc24e5f9" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/59306a29e4bbd510dc24e5f9", - "type": "Microsoft.ApiManagement/service/workspaces/groups", "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/59306a29e4bbd510dc24e5f9", "properties": { - "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "type": "external", "description": "awesome group of people", "builtIn": false, - "type": "external", + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" } } } - } + }, + "operationId": "WorkspaceGroup_Get", + "title": "ApiManagementGetWorkspaceGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceLink.json index 706e28572eaf..9a4e1bf2675b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceLink.json @@ -1,27 +1,29 @@ { "parameters": { - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", "serviceName": "service1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wk-1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/service-1/workspaceLinks/wk-1", "name": "wk-1", "type": "Microsoft.ApiManagement/service/workspaceLinks", "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/service-1/workspaceLinks/wk-1", "properties": { - "workspaceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/service-1/workspaces/wk-1", "gateways": [ { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/gateway-1" } - ] + ], + "workspaceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/service-1/workspaces/wk-1" } } } - } + }, + "operationId": "ApiManagementWorkspaceLink_Get", + "title": "ApiManagementGetWorkspaceLinks" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceLogger.json index 9658da0da129..b63d9674e04c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceLogger.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceLogger.json @@ -1,29 +1,31 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "loggerId": "templateLogger", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "loggerId": "templateLogger" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/kloudapilogger1", - "type": "Microsoft.ApiManagement/service/workspaces/loggers", "name": "kloudapilogger1", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/kloudapilogger1", "properties": { - "loggerType": "azureEventHub", "description": "testeventhub3again", "credentials": { "name": "testeventhub4", "connectionString": "Endpoint=sb://eventhubapim.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=************" }, "isBuffered": true, + "loggerType": "azureEventHub", "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/eventhubapim" } } } - } + }, + "operationId": "WorkspaceLogger_Get", + "title": "ApiManagementGetWorkspaceLogger" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceNamedValue.json index 30d23c4e129f..83e718316f96 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceNamedValue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceNamedValue.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "namedValueId": "testarmTemplateproperties2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "namedValueId": "testarmTemplateproperties2" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testarmTemplateproperties2", - "type": "Microsoft.ApiManagement/service/workspaces/namedValues", "name": "testarmTemplateproperties2", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testarmTemplateproperties2", "properties": { "displayName": "propName", - "value": "propValue", + "secret": false, "tags": [ "foo", "bar" ], - "secret": false + "value": "propValue" } } } - } + }, + "operationId": "WorkspaceNamedValue_Get", + "title": "ApiManagementGetWorkspaceNamedValue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceNamedValueWithKeyVault.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceNamedValueWithKeyVault.json index b2485ec69623..a82e4cb5bf7b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceNamedValueWithKeyVault.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceNamedValueWithKeyVault.json @@ -1,35 +1,37 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "namedValueId": "testprop6", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "namedValueId": "testprop6" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testarmTemplateproperties2", - "type": "Microsoft.ApiManagement/service/workspaces/namedValues", "name": "testprop6", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testarmTemplateproperties2", "properties": { "displayName": "prop6namekv", "keyVault": { - "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-11T00:54:31.8024882Z" - } + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" }, + "secret": true, "tags": [ "foo", "bar" - ], - "secret": true + ] } } } - } + }, + "operationId": "WorkspaceNamedValue_Get", + "title": "ApiManagementGetWorkspaceNamedValueWithKeyVault" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceNotification.json index 11f09c710e9d..3a2b10d86c68 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceNotification.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceNotification.json @@ -1,20 +1,19 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "notificationName": "RequestPublisherNotificationMessage" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage", - "type": "Microsoft.ApiManagement/service/workspaces/notifications", "name": "RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/workspaces/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage", "properties": { - "title": "Subscription requests (requiring approval)", "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", "recipients": { "emails": [ @@ -25,9 +24,12 @@ "users": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" ] - } + }, + "title": "Subscription requests (requiring approval)" } } } - } + }, + "operationId": "WorkspaceNotification_Get", + "title": "ApiManagementGetWorkspaceNotification" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspacePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspacePolicy.json index c6a7fb846590..4daaf9ad90a1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspacePolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspacePolicy.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "policyId": "policy" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", "properties": { "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "WorkspacePolicy_Get", + "title": "ApiManagementGetWorkspacePolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspacePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspacePolicyFragment.json index 16eeb0e67ada..c9e9f03cd430 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspacePolicyFragment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspacePolicyFragment.json @@ -1,18 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "id": "policyFragment1" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", - "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", "properties": { "format": "xml", "description": "A policy fragment example", @@ -20,5 +20,7 @@ } } } - } + }, + "operationId": "WorkspacePolicyFragment_Get", + "title": "ApiManagementGetWorkspacePolicyFragment" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspacePolicyFragmentFormat.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspacePolicyFragmentFormat.json index 31cbb6aef4ee..1d8beac6938c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspacePolicyFragmentFormat.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspacePolicyFragmentFormat.json @@ -1,19 +1,19 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "format": "rawxml", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "id": "policyFragment1", - "format": "rawxml" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", - "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", "properties": { "format": "rawxml", "description": "A policy fragment example", @@ -21,5 +21,7 @@ } } } - } + }, + "operationId": "WorkspacePolicyFragment_Get", + "title": "ApiManagementGetWorkspacePolicyFragmentFormat" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProduct.json index c5fbd14474b2..75d09d7334aa 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProduct.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "productId": "unlimited", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "productId": "unlimited" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/unlimited", - "type": "Microsoft.ApiManagement/service/workspaces/products", "name": "unlimited", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/unlimited", "properties": { - "displayName": "Unlimited", "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", - "subscriptionRequired": true, "approvalRequired": true, - "subscriptionsLimit": 1, - "state": "published" + "displayName": "Unlimited", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1 } } } - } + }, + "operationId": "WorkspaceProduct_Get", + "title": "ApiManagementGetWorkspaceProduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProductApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProductApiLink.json index 5b3cf27d9760..af2071993b53 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProductApiLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProductApiLink.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", + "apiLinkId": "link1", "productId": "testproduct", - "apiLinkId": "link1" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" } } } - } + }, + "operationId": "WorkspaceProductApiLink_Get", + "title": "ApiManagementGetWorkspaceProductApiLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProductGroupLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProductGroupLink.json index 4d2352e5f7e7..136d12b0b6e2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProductGroupLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProductGroupLink.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", + "groupLinkId": "link1", "productId": "testproduct", - "groupLinkId": "link1" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/groupLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/products/groupLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/groupLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct/groupLinks/link1", "properties": { "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" } } } - } + }, + "operationId": "WorkspaceProductGroupLink_Get", + "title": "ApiManagementGetWorkspaceProductGroupLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProductPolicy.json index a6d05202d71c..3b9a4a405401 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProductPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceProductPolicy.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", + "policyId": "policy", "productId": "kjoshiarmTemplateProduct4", - "policyId": "policy" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/kjoshiarmTemplateProduct4/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/products/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/kjoshiarmTemplateProduct4/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } } } - } + }, + "operationId": "WorkspaceProductPolicy_Get", + "title": "ApiManagementGetWorkspaceProductPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceSchema.json index 576998dd1534..0dc6867f9744 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceSchema.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceSchema.json @@ -1,18 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "schemaId": "schema1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "schemaId": "schema1" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", - "type": "Microsoft.ApiManagement/service/workspaces/schemas", "name": "schema1", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", "properties": { "description": "sample schema description", "schemaType": "xml", @@ -20,5 +20,7 @@ } } } - } + }, + "operationId": "WorkspaceGlobalSchema_Get", + "title": "ApiManagementGetWorkspaceSchema" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceSubscription.json index 1b65ee7ccb57..8dfe853f62a2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceSubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceSubscription.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "5931a769d8d14f0ad8ce13b8", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "sid": "5931a769d8d14f0ad8ce13b8" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/5931a769d8d14f0ad8ce13b8", - "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", "name": "5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/5931a769d8d14f0ad8ce13b8", "properties": { + "createdDate": "2017-06-02T17:59:06.223Z", + "displayName": "Unlimited", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", - "displayName": "Unlimited", - "state": "submitted", - "createdDate": "2017-06-02T17:59:06.223Z" + "state": "submitted" } } } - } + }, + "operationId": "WorkspaceSubscription_Get", + "title": "ApiManagementGetWorkspaceSubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTag.json index dc3e36d77f0c..6e2db2cbdabe 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTag.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "tagId": "59306a29e4bbd510dc24e5f9" + "tagId": "59306a29e4bbd510dc24e5f9", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/59306a29e4bbd510dc24e5f9", - "type": "Microsoft.ApiManagement/service/workspaces/tags", "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/59306a29e4bbd510dc24e5f9", "properties": { "displayName": "tag1" } } } - } + }, + "operationId": "WorkspaceTag_Get", + "title": "ApiManagementGetWorkspaceTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTagApiLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTagApiLink.json index e68a2a5c712e..1a7717d4eb63 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTagApiLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTagApiLink.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "apiLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "tagId": "tag1", - "apiLinkId": "link1" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" } } } - } + }, + "operationId": "WorkspaceTagApiLink_Get", + "title": "ApiManagementGetWorkspaceTagApiLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTagOperationLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTagOperationLink.json index a55d2cb955e6..ce6da296bc42 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTagOperationLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTagOperationLink.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "operationLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "tagId": "tag1", - "operationLinkId": "link1" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", "properties": { "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" } } } - } + }, + "operationId": "WorkspaceTagOperationLink_Get", + "title": "ApiManagementGetWorkspaceTagOperationLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTagProductLink.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTagProductLink.json index a0937c740fc4..2a4817123d75 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTagProductLink.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementGetWorkspaceTagProductLink.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "productLinkId": "link1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "tagId": "tag1", - "productLinkId": "link1" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" } } } - } + }, + "operationId": "WorkspaceTagProductLink_Get", + "title": "ApiManagementGetWorkspaceTagProductLink" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApi.json index ce7b4c3b04fe..abbc87c500a2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApi.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "57d1f7558aa04f15146d9d8a" + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "Api_GetEntityTag", + "title": "ApiManagementHeadApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiDiagnostic.json index ec09ab7a114c..1061a3fdc68d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiDiagnostic.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "57d1f7558aa04f15146d9d8a", "diagnosticId": "applicationinsights", - "apiId": "57d1f7558aa04f15146d9d8a" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ApiDiagnostic_GetEntityTag", + "title": "ApiManagementHeadApiDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiIssue.json index 3f13181172ae..81a911481822 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiIssue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiIssue.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", - "issueId": "57d2ef278aa04f0ad01d6cdc" + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ApiIssue_GetEntityTag", + "title": "ApiManagementHeadApiIssue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiIssueAttachment.json index 2107e0aee82a..f65e866782ad 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiIssueAttachment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiIssueAttachment.json @@ -1,12 +1,12 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", + "attachmentId": "57d2ef278aa04f0888cba3f3", "issueId": "57d2ef278aa04f0ad01d6cdc", - "attachmentId": "57d2ef278aa04f0888cba3f3" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -14,5 +14,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ApiIssueAttachment_GetEntityTag", + "title": "ApiManagementHeadApiIssueAttachment" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiIssueComment.json index f9b299b8fb67..8b1d98827dab 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiIssueComment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiIssueComment.json @@ -1,12 +1,12 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", + "commentId": "599e29ab193c3c0bd0b3e2fb", "issueId": "57d2ef278aa04f0ad01d6cdc", - "commentId": "599e29ab193c3c0bd0b3e2fb" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -14,5 +14,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ApiIssueComment_GetEntityTag", + "title": "ApiManagementHeadApiIssueComment" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiOperation.json index a3bfa1f642b9..b283396f49f1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiOperation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiOperation.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "57d2ef278aa04f0ad01d6cdc", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", - "operationId": "57d2ef278aa04f0ad01d6cdc" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ApiOperation_GetEntityTag", + "title": "ApiManagementHeadApiOperation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiOperationPolicy.json index 48498c524589..48b69032d06d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiOperationPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiOperationPolicy.json @@ -1,12 +1,12 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "5600b53ac53f5b0062080006", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "5600b539c53f5b0062040001", - "operationId": "5600b53ac53f5b0062080006", - "policyId": "policy" + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -14,5 +14,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ApiOperationPolicy_GetEntityTag", + "title": "ApiManagementHeadApiOperationPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiOperationTag.json index 2a7a9a5595a1..7b5180e9caf8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiOperationTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiOperationTag.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "59d6bb8f1f7fab13dc67ec9a", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "59d6bb8f1f7fab13dc67ec9b", - "operationId": "59d6bb8f1f7fab13dc67ec9a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagId": "59306a29e4bbd510dc24e5f9" }, "responses": { @@ -14,5 +14,7 @@ "Etag": "AAAAAAAACCI=" } } - } + }, + "operationId": "Tag_GetEntityStateByOperation", + "title": "ApiManagementHeadApiOperationTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiPolicy.json index c2ae29542bca..c5a2a46166cf 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiPolicy.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d1f7558aa04f15146d9d8a", - "policyId": "policy" + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ApiPolicy_GetEntityTag", + "title": "ApiManagementHeadApiPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiRelease.json index c8492cde86fa..7aea66b683e5 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiRelease.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiRelease.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "a1", - "releaseId": "5a7cb545298324c53224a799" + "releaseId": "5a7cb545298324c53224a799", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ApiRelease_GetEntityTag", + "title": "ApiManagementHeadApiRelease" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiSchema.json index 90974b7fa1f9..96d05b23371c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiSchema.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiSchema.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d1f7558aa04f15146d9d8a", - "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1" + "resourceGroupName": "rg1", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ApiSchema_GetEntityTag", + "title": "ApiManagementHeadApiSchema" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiTag.json index 9d7fc067d596..441f8a4a7076 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiTag.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "59d6bb8f1f7fab13dc67ec9b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagId": "59306a29e4bbd510dc24e5f9" }, "responses": { @@ -13,5 +13,7 @@ "Etag": "AAAAAAAACCI=" } } - } + }, + "operationId": "Tag_GetEntityStateByApi", + "title": "ApiManagementHeadApiTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiTagDescription.json index d07f4561a371..f52e2499a546 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiTagDescription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiTagDescription.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "59d6bb8f1f7fab13dc67ec9b", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagDescriptionId": "59306a29e4bbd510dc24e5f9" }, "responses": { @@ -13,5 +13,7 @@ "Etag": "AAAAAAAACCI=" } } - } + }, + "operationId": "ApiTagDescription_GetEntityTag", + "title": "ApiManagementHeadApiTagDescription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiVersionSet.json index e674fd4ebbd2..976b12ebdb8d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiVersionSet.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiVersionSet.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "versionSetId": "vs1" }, @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ApiVersionSet_GetEntityTag", + "title": "ApiManagementHeadApiVersionSet" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiWiki.json index ce7b4c3b04fe..23b82339b9bd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiWiki.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadApiWiki.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "57d1f7558aa04f15146d9d8a" + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ApiWiki_GetEntityTag", + "title": "ApiManagementHeadApiWiki" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadAuthorizationServer.json index ee394ae2622b..c73cab428ff8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadAuthorizationServer.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadAuthorizationServer.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "authsid": "newauthServer2" + "authsid": "newauthServer2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "AuthorizationServer_GetEntityTag", + "title": "ApiManagementHeadAuthorizationServer" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadBackend.json index aadd4034d22f..3787f08f065d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadBackend.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadBackend.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "backendId": "sfbackend" + "backendId": "sfbackend", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "Backend_GetEntityTag", + "title": "ApiManagementHeadBackend" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadCache.json index aa77b4871382..63dd3cb3bfd4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadCache.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadCache.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "cacheId": "default" + "cacheId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "Cache_GetEntityTag", + "title": "ApiManagementHeadCache" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadCertificate.json index 39c5fbbf41b5..0a13848e9f92 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadCertificate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadCertificate.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "certificateId": "templateCert1" + "certificateId": "templateCert1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "Certificate_GetEntityTag", + "title": "ApiManagementHeadCertificate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadClientApplication.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadClientApplication.json index 9c3d26a625ba..3cdd9b9e6311 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadClientApplication.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadClientApplication.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "clientApplicationId": "testAppId" + "clientApplicationId": "testAppId", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ClientApplication_GetEntityTag", + "title": "ApiManagementHeadProduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadContentTypeContentItem.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadContentTypeContentItem.json index 6abb3b026d89..b8ea032c7d1c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadContentTypeContentItem.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadContentTypeContentItem.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", "contentTypeId": "page", - "contentItemId": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ContentItem_GetEntityTag", + "title": "ApiManagementHeadContentTypeContentItem" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadDelegationSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadDelegationSettings.json index 17ad81be4d99..7aae590a04f3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadDelegationSettings.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadDelegationSettings.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -11,5 +11,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "DelegationSettings_GetEntityTag", + "title": "ApiManagementHeadDelegationSettings" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadDiagnostic.json index d5d0d7aea9dd..b7dfdb23c00d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadDiagnostic.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "diagnosticId": "applicationinsights" + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "Diagnostic_GetEntityTag", + "title": "ApiManagementHeadDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadDocumentation.json index 02979b9c10bd..6298b444d324 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadDocumentation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadDocumentation.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "documentationId": "57d1f7558aa04f15146d9d8a" + "documentationId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "Documentation_GetEntityTag", + "title": "ApiManagementHeadDocumentation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadEmailTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadEmailTemplate.json index 67f878ccf69a..fa2558b93693 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadEmailTemplate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadEmailTemplate.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "templateName": "newIssueNotificationMessage" }, @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "EmailTemplate_GetEntityTag", + "title": "ApiManagementHeadEmailTemplate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGateway.json index d1b49c0164e1..a81502c428e9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGateway.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGateway.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "gatewayId": "mygateway" + "gatewayId": "mygateway", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "Gateway_GetEntityTag", + "title": "ApiManagementHeadGateway" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGatewayApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGatewayApi.json index 912f6aef49b3..3d294a4888e9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGatewayApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGatewayApi.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "api1", "gatewayId": "gw1", - "apiId": "api1" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "Etag": "AAAAAAAACCI=" } } - } + }, + "operationId": "GatewayApi_GetEntityTag", + "title": "ApiManagementHeadGatewayApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGatewayCertificateAuthority.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGatewayCertificateAuthority.json index 86e52641c283..52ca1929ff56 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGatewayCertificateAuthority.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGatewayCertificateAuthority.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "certificateId": "cert1", "gatewayId": "gw1", - "certificateId": "cert1" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "GatewayCertificateAuthority_GetEntityTag", + "title": "ApiManagementHeadGatewayCertificateAuthority" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGatewayHostnameConfiguration.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGatewayHostnameConfiguration.json index 1d06a5dfda93..79699881408f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGatewayHostnameConfiguration.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGatewayHostnameConfiguration.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "gatewayId": "gw1", - "hcId": "default" + "hcId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "GatewayHostnameConfiguration_GetEntityTag", + "title": "ApiManagementHeadGatewayHostnameConfiguration" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGlobalSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGlobalSchema.json index 15dc13b6ec15..587dcab841ad 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGlobalSchema.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGlobalSchema.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "schemaId": "myschema" + "resourceGroupName": "rg1", + "schemaId": "myschema", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "GlobalSchema_GetEntityTag", + "title": "ApiManagementHeadApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGraphQLApiResolver.json index 42d38f910e37..6073db51e9b9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGraphQLApiResolver.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGraphQLApiResolver.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", - "resolverId": "57d2ef278aa04f0ad01d6cdc" + "resolverId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "GraphQLApiResolver_GetEntityTag", + "title": "ApiManagementHeadGraphQLApiResolver" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGraphQLApiResolverPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGraphQLApiResolverPolicy.json index 3b35ef3cec3a..69e31ea2b58b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGraphQLApiResolverPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGraphQLApiResolverPolicy.json @@ -1,12 +1,12 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "5600b539c53f5b0062040001", + "policyId": "policy", "resolverId": "5600b53ac53f5b0062080006", - "policyId": "policy" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -14,5 +14,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "GraphQLApiResolverPolicy_GetEntityTag", + "title": "ApiManagementHeadGraphQLApiResolverPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGroup.json index 470c1b1849cb..cfb52ac42c18 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGroup.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "groupId": "59306a29e4bbd510dc24e5f9" + "groupId": "59306a29e4bbd510dc24e5f9", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "Group_GetEntityTag", + "title": "ApiManagementHeadGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGroupUser.json index ad4555556537..8d07680b1a57 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGroupUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadGroupUser.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "groupId": "59306a29e4bbd510dc24e5f9", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userId": "5931a75ae4bbd512a88c680b" }, "responses": { "204": {}, "404": {} - } + }, + "operationId": "GroupUser_CheckEntityExists", + "title": "ApiManagementHeadGroupUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadIdentityProvider.json index a75b178ee513..f36c8e7018e2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadIdentityProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadIdentityProvider.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "identityProviderName": "aadB2C" + "identityProviderName": "aadB2C", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "IdentityProvider_GetEntityTag", + "title": "ApiManagementHeadIdentityProvider" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadLogger.json index 128c92d928f1..55edc401a409 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadLogger.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadLogger.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "loggerId": "templateLogger" + "loggerId": "templateLogger", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "Logger_GetEntityTag", + "title": "ApiManagementHeadLogger" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadNamedValue.json index cf495b77d1dc..510a2437b070 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadNamedValue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadNamedValue.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "namedValueId": "testarmTemplateproperties2" + "namedValueId": "testarmTemplateproperties2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "NamedValue_GetEntityTag", + "title": "ApiManagementHeadNamedValue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadNotificationRecipientEmail.json index 4fa7214a9d51..4b3bc6fb2d25 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadNotificationRecipientEmail.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadNotificationRecipientEmail.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "email": "contoso@live.com", "notificationName": "RequestPublisherNotificationMessage", - "email": "contoso@live.com" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "204": {}, "404": {} - } + }, + "operationId": "NotificationRecipientEmail_CheckEntityExists", + "title": "ApiManagementHeadNotificationRecipientEmail" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadNotificationRecipientUser.json index ac4f42a405a3..94f98a7e0c17 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadNotificationRecipientUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadNotificationRecipientUser.json @@ -1,14 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userId": "576823d0a40f7e74ec07d642" }, "responses": { "204": {}, "404": {} - } + }, + "operationId": "NotificationRecipientUser_CheckEntityExists", + "title": "ApiManagementHeadNotificationRecipientUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadOpenIdConnectProvider.json index febd05a18bb5..f930a81ab409 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadOpenIdConnectProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadOpenIdConnectProvider.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "opid": "templateOpenIdConnect2" + "opid": "templateOpenIdConnect2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "OpenIdConnectProvider_GetEntityTag", + "title": "ApiManagementHeadOpenIdConnectProvider" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPolicy.json index a8b49a4d663c..b26d9140452d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPolicy.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "policyId": "policy" + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "Policy_GetEntityTag", + "title": "ApiManagementHeadPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPolicyFragment.json index 5775952d25d7..dfad86ce9499 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPolicyFragment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPolicyFragment.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "id": "policyFragment1" + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "PolicyFragment_GetEntityTag", + "title": "ApiManagementHeadPolicyFragment" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPolicyRestriction.json index 0ef9bc9bcd61..94be240ba80e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPolicyRestriction.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPolicyRestriction.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "policyRestrictionId": "policyRestriction1" + "policyRestrictionId": "policyRestriction1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "PolicyRestriction_GetEntityTag", + "title": "ApiManagementHeadPolicyRestriction" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPortalConfig.json index f9c2868930ca..33dcc777c7b2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPortalConfig.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPortalConfig.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "portalConfigId": "default" + "portalConfigId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "PortalConfig_GetEntityTag", + "title": "ApiManagementHeadPortalConfig" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPortalRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPortalRevision.json index ce77979b9af0..9568681e1202 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPortalRevision.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadPortalRevision.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "portalRevisionId": "20201112101010" + "portalRevisionId": "20201112101010", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "PortalRevision_GetEntityTag", + "title": "ApiManagementHeadPortalRevision" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProduct.json index 13075924f5de..f9e4344d7910 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProduct.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "unlimited" + "productId": "unlimited", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "Product_GetEntityTag", + "title": "ApiManagementHeadProduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductApi.json index 17dfd2e2c362..d5afb94bcb95 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductApi.json @@ -1,13 +1,15 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "apiId": "59306a29e4bbd510dc24e5f9", "productId": "5931a75ae4bbd512a88c680b", - "apiId": "59306a29e4bbd510dc24e5f9" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "204": {} - } + }, + "operationId": "ProductApi_CheckEntityExists", + "title": "ApiManagementHeadProductApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductGroup.json index a2186403e5a4..88068f1f4949 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductGroup.json @@ -1,13 +1,15 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "groupId": "59306a29e4bbd510dc24e5f9", "productId": "5931a75ae4bbd512a88c680b", - "groupId": "59306a29e4bbd510dc24e5f9" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "204": {} - } + }, + "operationId": "ProductGroup_CheckEntityExists", + "title": "ApiManagementHeadProductGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductPolicy.json index e97c17814837..4923af59a2c9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductPolicy.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "policyId": "policy", "productId": "unlimited", - "policyId": "policy" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ProductPolicy_GetEntityTag", + "title": "ApiManagementHeadProductPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductTag.json index 6137106e6957..2cb5710fd5ae 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductTag.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "productId": "59306a29e4bbd510dc24e5f8", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagId": "59306a29e4bbd510dc24e5f9" }, "responses": { @@ -13,5 +13,7 @@ "Etag": "AAAAAAAACCI=" } } - } + }, + "operationId": "Tag_GetEntityStateByProduct", + "title": "ApiManagementHeadProductTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductWiki.json index 2565a4d8f4d8..822736fad422 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductWiki.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadProductWiki.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "57d1f7558aa04f15146d9d8a" + "productId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "ProductWiki_GetEntityTag", + "title": "ApiManagementHeadProductWiki" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadSignInSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadSignInSettings.json index 17ad81be4d99..f8780174e1b5 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadSignInSettings.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadSignInSettings.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -11,5 +11,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "SignInSettings_GetEntityTag", + "title": "ApiManagementHeadSignInSettings" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadSignUpSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadSignUpSettings.json index 17ad81be4d99..b9addd645eb0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadSignUpSettings.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadSignUpSettings.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -11,5 +11,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "SignUpSettings_GetEntityTag", + "title": "ApiManagementHeadSignUpSettings" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadSubscription.json index 5eff658f5343..7e414c4dd79c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadSubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadSubscription.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "sid": "5931a769d8d14f0ad8ce13b8" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "5931a769d8d14f0ad8ce13b8", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "Subscription_GetEntityTag", + "title": "ApiManagementHeadSubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadTag.json index ae4aa167cdb0..bfc9414dbbbd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadTag.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagId": "59306a29e4bbd510dc24e5f9" }, @@ -12,5 +12,7 @@ "Etag": "AAAAAAAACCI=" } } - } + }, + "operationId": "Tag_GetEntityState", + "title": "ApiManagementHeadTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadTenantAccess.json index a0ac95319093..756ba9397c15 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadTenantAccess.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadTenantAccess.json @@ -1,12 +1,14 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "accessName": "access", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "accessName": "access" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {} - } + }, + "operationId": "TenantAccess_GetEntityTag", + "title": "ApiManagementHeadTenantAccess" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadUser.json index 620b7f94afd1..b6bdf0bbc68d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadUser.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "userId": "5931a75ae4bbd512a88c680b" }, @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "User_GetEntityTag", + "title": "ApiManagementHeadUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspace.json index f434666d4c29..cfd544baa0c2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspace.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspace.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks" }, @@ -12,5 +12,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "Workspace_GetEntityTag", + "title": "ApiManagementHeadWorkspace" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApi.json index e8e5fd67233f..64f4359c1ff6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApi.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "apiId": "57d1f7558aa04f15146d9d8a" + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceApi_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiDiagnostic.json index 93e1dcae4a50..231053610d08 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiDiagnostic.json @@ -1,12 +1,12 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", + "apiId": "57d1f7558aa04f15146d9d8a", "diagnosticId": "applicationinsights", - "apiId": "57d1f7558aa04f15146d9d8a" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { @@ -14,5 +14,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceApiDiagnostic_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApiDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiOperation.json index 0d800f2bab4e..ec9ff7e4f5a2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiOperation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiOperation.json @@ -1,12 +1,12 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "57d2ef278aa04f0ad01d6cdc", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "57d2ef278aa04f0888cba3f3", - "operationId": "57d2ef278aa04f0ad01d6cdc" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { @@ -14,5 +14,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceApiOperation_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApiOperation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiOperationPolicy.json index 0c04978155d7..7641eecd916d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiOperationPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiOperationPolicy.json @@ -1,13 +1,13 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "5600b53ac53f5b0062080006", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "5600b539c53f5b0062040001", - "operationId": "5600b53ac53f5b0062080006", - "policyId": "policy" + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { @@ -15,5 +15,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceApiOperationPolicy_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApiOperationPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiPolicy.json index 781c894ef2dd..b146011d66d8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiPolicy.json @@ -1,12 +1,12 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "57d1f7558aa04f15146d9d8a", - "policyId": "policy" + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { @@ -14,5 +14,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceApiPolicy_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApiPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiRelease.json index b473973a875d..73af9408e4c0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiRelease.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiRelease.json @@ -1,12 +1,12 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "a1", - "releaseId": "5a7cb545298324c53224a799" + "releaseId": "5a7cb545298324c53224a799", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { @@ -14,5 +14,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceApiRelease_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApiRelease" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiSchema.json index f396cf347bae..30c16b683a55 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiSchema.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiSchema.json @@ -1,12 +1,12 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "57d1f7558aa04f15146d9d8a", - "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1" + "resourceGroupName": "rg1", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { @@ -14,5 +14,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceApiSchema_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApiSchema" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiVersionSet.json index e62faa019c2b..45d2bcbd93f2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiVersionSet.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceApiVersionSet.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "versionSetId": "vs1" + "versionSetId": "vs1", + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceApiVersionSet_GetEntityTag", + "title": "ApiManagementHeadWorkspaceApiVersionSet" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceBackend.json index 6917b28e239a..886bbc1969b8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceBackend.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceBackend.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "backendId": "sfbackend", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "backendId": "sfbackend" + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceBackend_GetEntityTag", + "title": "ApiManagementHeadWorkspaceBackend" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceCertificate.json index a9567d03c00a..f7116659d337 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceCertificate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceCertificate.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "certificateId": "templateCert1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "certificateId": "templateCert1" + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceCertificate_GetEntityTag", + "title": "ApiManagementWorkspaceHeadCertificate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceDiagnostic.json index 9c6a1e5ed87d..a033b399e02b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceDiagnostic.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "diagnosticId": "applicationinsights", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "diagnosticId": "applicationinsights" + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceDiagnostic_GetEntityTag", + "title": "ApiManagementHeadWorkspaceDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceGroup.json index 0e160706e11e..03c69bf826fa 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceGroup.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "groupId": "59306a29e4bbd510dc24e5f9", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "groupId": "59306a29e4bbd510dc24e5f9" + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceGroup_GetEntityTag", + "title": "ApiManagementHeadWorkspaceGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceGroupUser.json index 265f910e66c2..0fbf0ed7828d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceGroupUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceGroupUser.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "groupId": "59306a29e4bbd510dc24e5f9", - "userId": "5931a75ae4bbd512a88c680b" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512a88c680b", + "workspaceId": "wks1" }, "responses": { "204": {}, "404": {} - } + }, + "operationId": "WorkspaceGroupUser_CheckEntityExists", + "title": "ApiManagementHeadWorkspaceGroupUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceLogger.json index 580cf7fd1812..64e38a85eab2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceLogger.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceLogger.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "loggerId": "templateLogger", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "loggerId": "templateLogger" + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceLogger_GetEntityTag", + "title": "ApiManagementHeadWorkspaceLogger" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceNamedValue.json index f935507fb584..a9ec26b7f675 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceNamedValue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceNamedValue.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "namedValueId": "testarmTemplateproperties2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "namedValueId": "testarmTemplateproperties2" + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceNamedValue_GetEntityTag", + "title": "ApiManagementHeadWorkspaceNamedValue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientEmail.json index 45fead7aeaa2..6b406e76650f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientEmail.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientEmail.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", + "email": "contoso@live.com", "notificationName": "RequestPublisherNotificationMessage", - "email": "contoso@live.com" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "204": {}, "404": {} - } + }, + "operationId": "WorkspaceNotificationRecipientEmail_CheckEntityExists", + "title": "ApiManagementHeadWorkspaceNotificationRecipientEmail" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientUser.json index e40f60053111..37991a4a4393 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceNotificationRecipientUser.json @@ -1,15 +1,17 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "notificationName": "RequestPublisherNotificationMessage", - "userId": "576823d0a40f7e74ec07d642" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "576823d0a40f7e74ec07d642", + "workspaceId": "wks1" }, "responses": { "204": {}, "404": {} - } + }, + "operationId": "WorkspaceNotificationRecipientUser_CheckEntityExists", + "title": "ApiManagementHeadWorkspaceNotificationRecipientUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspacePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspacePolicy.json index cfc23e8fe5cd..85322b8f83c1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspacePolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspacePolicy.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "policyId": "policy", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "policyId": "policy" + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspacePolicy_GetEntityTag", + "title": "ApiManagementHeadWorkspacePolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspacePolicyFragment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspacePolicyFragment.json index 7434de0e835b..f7731c77a1fa 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspacePolicyFragment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspacePolicyFragment.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "id": "policyFragment1" + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspacePolicyFragment_GetEntityTag", + "title": "ApiManagementHeadWorkspacePolicyFragment" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceProduct.json index 85afd47f3710..c823288d168d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceProduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceProduct.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "productId": "unlimited", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "productId": "unlimited" + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceProduct_GetEntityTag", + "title": "ApiManagementHeadWorkspaceProduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceProductPolicy.json index fc1f7c6e0eea..bc56629a5da6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceProductPolicy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceProductPolicy.json @@ -1,12 +1,12 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", + "policyId": "policy", "productId": "unlimited", - "policyId": "policy" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { @@ -14,5 +14,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceProductPolicy_GetEntityTag", + "title": "ApiManagementHeadWorkspaceProductPolicy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceSchema.json index ca046f2fa147..6c963997664a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceSchema.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceSchema.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "schemaId": "myschema", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "schemaId": "myschema" + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceGlobalSchema_GetEntityTag", + "title": "ApiManagementHeadWorkspaceSchema" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceSubscription.json index 4fcf5cfc3323..aa7473e708dd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceSubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceSubscription.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "5931a769d8d14f0ad8ce13b8", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "sid": "5931a769d8d14f0ad8ce13b8" + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "etag": "AAAAAAAAAAa=" } } - } + }, + "operationId": "WorkspaceSubscription_GetEntityTag", + "title": "ApiManagementHeadWorkspaceSubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceTag.json index 801cc6207ec3..35846dd5113f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementHeadWorkspaceTag.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "tagId": "59306a29e4bbd510dc24e5f9" + "tagId": "59306a29e4bbd510dc24e5f9", + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "Etag": "AAAAAAAACCI=" } } - } + }, + "operationId": "WorkspaceTag_GetEntityState", + "title": "ApiManagementHeadWorkspaceTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementIdentityProviderListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementIdentityProviderListSecrets.json index 151599f29b9c..bb4ceaef7a0d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementIdentityProviderListSecrets.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementIdentityProviderListSecrets.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "identityProviderName": "aadB2C" + "identityProviderName": "aadB2C", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "clientSecret": "XXXXXXX" } } - } + }, + "operationId": "IdentityProvider_ListSecrets", + "title": "ApiManagementIdentityProviderListSecrets" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiDiagnostics.json index 471867cb9383..85259f7c66c7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiDiagnostics.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiDiagnostics.json @@ -1,61 +1,63 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "echo-api" + "apiId": "echo-api", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/apis/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "httpCorrelationProtocol": "Legacy", - "logClientIp": true, - "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", - "sampling": { - "samplingType": "fixed", - "percentage": 100 - }, - "frontend": { - "request": { - "headers": [], + "backend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } }, - "backend": { - "request": { - "headers": [], + "frontend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" } } } - ], - "count": 1 + ] } } - } + }, + "operationId": "ApiDiagnostic_ListByService", + "title": "ApiManagementListApiDiagnostics" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiIssueAttachments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiIssueAttachments.json index 3539a4f63544..826391806b9b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiIssueAttachments.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiIssueAttachments.json @@ -1,30 +1,32 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d1f7558aa04f15146d9d8a", - "issueId": "57d2ef278aa04f0ad01d6cdc" + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", - "type": "Microsoft.ApiManagement/service/apis/issues/attachments", "name": "57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", "properties": { - "title": "Issue attachment.", + "content": "https://.../image.jpg", "contentFormat": "link", - "content": "https://.../image.jpg" + "title": "Issue attachment." } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ApiIssueAttachment_ListByService", + "title": "ApiManagementListApiIssueAttachments" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiIssueComments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiIssueComments.json index 25a16b15f919..761cba187e75 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiIssueComments.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiIssueComments.json @@ -1,30 +1,32 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d1f7558aa04f15146d9d8a", - "issueId": "57d2ef278aa04f0ad01d6cdc" + "issueId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", - "type": "Microsoft.ApiManagement/service/apis/issues/comments", "name": "599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", "properties": { - "text": "Issue comment.", "createdDate": "2018-02-01T22:21:20.467Z", + "text": "Issue comment.", "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ApiIssueComment_ListByService", + "title": "ApiManagementListApiIssueComments" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiIssues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiIssues.json index 16c28f4d98ea..a292e5bbbab6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiIssues.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiIssues.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "57d1f7558aa04f15146d9d8a" + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/apis/issues", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", "properties": { - "title": "New API issue", "description": "New API issue description", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", "createdDate": "2018-02-01T22:21:20.467Z", "state": "open", - "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", - "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a" + "title": "New API issue", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ApiIssue_ListByService", + "title": "ApiManagementListApiIssues" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperationPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperationPolicies.json index 9cafa2cccb18..0251ceb77683 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperationPolicies.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperationPolicies.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "599e29ab193c3c0bd0b3e2fb", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "599e2953193c3c0bd0b3e2fa", - "operationId": "599e29ab193c3c0bd0b3e2fb" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/599e2953193c3c0bd0b3e2fa/operations/599e29ab193c3c0bd0b3e2fb/policies/policy", - "type": "Microsoft.ApiManagement/service/apis/operations/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/599e2953193c3c0bd0b3e2fa/operations/599e29ab193c3c0bd0b3e2fb/policies/policy", "properties": { "value": "\r\n\r\n \r\n \r\n \r\n \r\n xxx\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ApiOperationPolicy_ListByOperation", + "title": "ApiManagementListApiOperationPolicies" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperationTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperationTags.json index c87bc9912e88..9a52d1fac4c4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperationTags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperationTags.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "57d2ef278aa04f0888cba3f6", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", - "operationId": "57d2ef278aa04f0888cba3f6" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", - "type": "Microsoft.ApiManagement/service/tags", "name": "5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", "properties": { "displayName": "tag1" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "Tag_ListByOperation", + "title": "ApiManagementListApiOperationTags" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperations.json index 06b1a0383845..addb090996f6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperations.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperations.json @@ -1,70 +1,72 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "57d2ef278aa04f0ad01d6cdc", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", - "operationId": "57d2ef278aa04f0ad01d6cdc" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 5, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/apis/operations", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", "properties": { - "displayName": "CancelOrder", "method": "POST", + "displayName": "CancelOrder", "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda", - "type": "Microsoft.ApiManagement/service/apis/operations", "name": "57d2ef278aa04f0ad01d6cda", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda", "properties": { - "displayName": "GetMostRecentOrder", "method": "POST", + "displayName": "GetMostRecentOrder", "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetMostRecentOrder" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9", - "type": "Microsoft.ApiManagement/service/apis/operations", "name": "57d2ef278aa04f0ad01d6cd9", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9", "properties": { - "displayName": "GetOpenOrders", "method": "POST", + "displayName": "GetOpenOrders", "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOpenOrders" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb", - "type": "Microsoft.ApiManagement/service/apis/operations", "name": "57d2ef278aa04f0ad01d6cdb", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb", "properties": { - "displayName": "GetOrder", "method": "POST", + "displayName": "GetOrder", "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOrder" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8", - "type": "Microsoft.ApiManagement/service/apis/operations", "name": "57d2ef278aa04f0ad01d6cd8", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8", "properties": { - "displayName": "submitOrder", "method": "POST", + "displayName": "submitOrder", "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/submitOrder" } } - ], - "count": 5, - "nextLink": "" + ] } } - } + }, + "operationId": "ApiOperation_ListByApi", + "title": "ApiManagementListApiOperations" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperationsByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperationsByTags.json index bb5f298fef14..24faafc9f9d1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperationsByTags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiOperationsByTags.json @@ -1,33 +1,35 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "a1" + "apiId": "a1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, "value": [ { - "tag": { - "id": "/tags/apitag123", - "name": "awesomeTag" - }, "operation": { - "id": "/apis/echo-api/operations/create-resource", - "apiName": "Echo API", - "apiRevision": "1", "name": "Create resource", "method": "POST", - "urlTemplate": "/resource", - "description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend." + "description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend.", + "apiName": "Echo API", + "apiRevision": "1", + "id": "/apis/echo-api/operations/create-resource", + "urlTemplate": "/resource" + }, + "tag": { + "name": "awesomeTag", + "id": "/tags/apitag123" } } - ], - "count": 1 + ] } } - } + }, + "operationId": "Operation_ListByTags", + "title": "ApiManagementListApiOperationsByTags" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiPolicies.json index 265b4074ca85..380ad783f977 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiPolicies.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiPolicies.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "5600b59475ff190048040001" + "apiId": "5600b59475ff190048040001", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b59475ff190048040001/policies/policy", - "type": "Microsoft.ApiManagement/service/apis/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b59475ff190048040001/policies/policy", "properties": { "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ApiPolicy_ListByApi", + "title": "ApiManagementListApiPolicies" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiProducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiProducts.json index b5fb29297d6e..2f4e9fa53523 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiProducts.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiProducts.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "57d2ef278aa04f0888cba3f3" + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b539c53f5b0062060002", - "type": "Microsoft.ApiManagement/service/apis/products", "name": "5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/apis/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b539c53f5b0062060002", "properties": { - "displayName": "Unlimited", "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", - "subscriptionRequired": true, "approvalRequired": true, - "subscriptionsLimit": 1, - "state": "published" + "displayName": "Unlimited", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1 } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ApiProduct_ListByApis", + "title": "ApiManagementListApiProducts" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiReleases.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiReleases.json index 51642cbdb899..f3affb8353e4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiReleases.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiReleases.json @@ -1,29 +1,31 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "a1" + "apiId": "a1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/5a7cb545298324c53224a799", - "type": "Microsoft.ApiManagement/service/apis/releases", "name": "5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/5a7cb545298324c53224a799", "properties": { "createdDateTime": "2018-02-08T20:38:29.173Z", - "updatedDateTime": "2018-02-08T20:38:29.173Z", - "notes": "yahoo" + "notes": "yahoo", + "updatedDateTime": "2018-02-08T20:38:29.173Z" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ApiRelease_ListByService", + "title": "ApiManagementListApiReleases" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiRevisions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiRevisions.json index 1b1d9c7c276f..bc7fc276a1b9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiRevisions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiRevisions.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "57d2ef278aa04f0888cba3f3" + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1;rev=1", "apiRevision": "1", "createdDateTime": "2018-02-01T22:21:20.467Z", - "updatedDateTime": "2018-02-01T22:21:20.467Z", + "isCurrent": true, "isOnline": true, - "isCurrent": true + "updatedDateTime": "2018-02-01T22:21:20.467Z" } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ApiRevision_ListByService", + "title": "ApiManagementListApiRevisions" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiSchemas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiSchemas.json index 2d321f1f2365..7c6996d7574c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiSchemas.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiSchemas.json @@ -1,19 +1,21 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "59d5b28d1f7fab116c282650" + "apiId": "59d5b28d1f7fab116c282650", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d5b28d1f7fab116c282650/schemas/59d5b28e1f7fab116402044e", - "type": "Microsoft.ApiManagement/service/apis/schemas", "name": "59d5b28e1f7fab116402044e", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d5b28d1f7fab116c282650/schemas/59d5b28e1f7fab116402044e", "properties": { "contentType": "application/vnd.ms-azure-apim.xsd+xml", "document": { @@ -21,10 +23,10 @@ } } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ApiSchema_ListByApi", + "title": "ApiManagementListApiSchemas" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiTagDescriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiTagDescriptions.json index 7e75bac06d34..3c9874925558 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiTagDescriptions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiTagDescriptions.json @@ -1,30 +1,32 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "57d2ef278aa04f0888cba3f3" + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tagDescriptions/5600b539c53f5b0062060002", - "type": "Microsoft.ApiManagement/service/tags", "name": "5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tagDescriptions/5600b539c53f5b0062060002", "properties": { - "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", "displayName": "tag1", "externalDocsDescription": "some additional info", - "externalDocsUrl": "http://some_url.com" + "externalDocsUrl": "http://some_url.com", + "tagId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ApiTagDescription_ListByService", + "title": "ApiManagementListApiTagDescriptions" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiTags.json index 2999b2280237..cfb6ece2c8c3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiTags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiTags.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "57d2ef278aa04f0888cba3f3" + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", - "type": "Microsoft.ApiManagement/service/tags", "name": "5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", "properties": { "displayName": "tag1" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "Tag_ListByApi", + "title": "ApiManagementListApiTags" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiVersionSets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiVersionSets.json index 905ee02e9d3a..77283086b077 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiVersionSets.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiVersionSets.json @@ -1,38 +1,40 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1", - "type": "Microsoft.ApiManagement/service/api-version-sets", "name": "vs1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1", "properties": { + "description": "Version configuration", "displayName": "api set 1", - "versioningScheme": "Segment", - "description": "Version configuration" + "versioningScheme": "Segment" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs2", - "type": "Microsoft.ApiManagement/service/api-version-sets", "name": "vs2", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs2", "properties": { + "description": "Version configuration 2", "displayName": "api set 2", - "versioningScheme": "Query", - "description": "Version configuration 2" + "versioningScheme": "Query" } } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "ApiVersionSet_ListByService", + "title": "ApiManagementListApiVersionSets" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiWikis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiWikis.json index f8420a82be92..e656d59140a7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiWikis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApiWikis.json @@ -1,19 +1,20 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "57d1f7558aa04f15146d9d8a" + "apiId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", - "type": "Microsoft.ApiManagement/service/apis/wikis", "name": "default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", "properties": { "documents": [ { @@ -25,9 +26,10 @@ ] } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "ApiWikis_List", + "title": "ApiManagementListApiWikis" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApis.json index 35f8b361fedd..b3c0d6d987f5 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApis.json @@ -1,82 +1,84 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 4, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", - "type": "Microsoft.ApiManagement/service/apis", "name": "a1", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", "properties": { - "displayName": "api1", - "apiRevision": "1", - "serviceUrl": "http://echoapi.cloudapp.net/api", "path": "api1", + "apiRevision": "1", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4", + "displayName": "api1", + "isCurrent": true, "protocols": [ "https" ], - "isCurrent": true, - "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4" + "serviceUrl": "http://echoapi.cloudapp.net/api" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a73933b8f27f7cc82a2d533", - "type": "Microsoft.ApiManagement/service/apis", "name": "5a73933b8f27f7cc82a2d533", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a73933b8f27f7cc82a2d533", "properties": { - "displayName": "api1", - "apiRevision": "1", - "serviceUrl": "http://echoapi.cloudapp.net/api", "path": "api1", + "apiRevision": "1", + "apiVersion": "v1", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4", + "displayName": "api1", + "isCurrent": true, "protocols": [ "https" ], - "isCurrent": true, - "apiVersion": "v1", - "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4" + "serviceUrl": "http://echoapi.cloudapp.net/api" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", - "type": "Microsoft.ApiManagement/service/apis", "name": "echo-api", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", "properties": { - "displayName": "Echo API", - "apiRevision": "1", - "serviceUrl": "http://echoapi.cloudapp.net/api", "path": "echo", + "apiRevision": "1", + "displayName": "Echo API", + "isCurrent": true, "protocols": [ "https" ], - "isCurrent": true + "serviceUrl": "http://echoapi.cloudapp.net/api" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a7390baa5816a110435aee0", - "type": "Microsoft.ApiManagement/service/apis", "name": "5a7390baa5816a110435aee0", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a7390baa5816a110435aee0", "properties": { - "displayName": "Swagger Petstore Extensive", - "apiRevision": "1", - "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", - "serviceUrl": "http://petstore.swagger.wordnik.com/api", "path": "vvv", + "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", + "apiRevision": "1", + "displayName": "Swagger Petstore Extensive", + "isCurrent": true, "protocols": [ "https" ], - "isCurrent": true + "serviceUrl": "http://petstore.swagger.wordnik.com/api" } } - ], - "count": 4, - "nextLink": "" + ] } } - } + }, + "operationId": "Api_ListByService", + "title": "ApiManagementListApis" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApisByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApisByTags.json index 98323fca63a0..75da2d01a80b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApisByTags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListApisByTags.json @@ -1,31 +1,33 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, "value": [ { - "tag": { - "id": "/tags/apitag123", - "name": "awesomeTag" - }, "api": { - "id": "/apis/echo-api", "name": "Echo API", - "apiRevision": "1", - "serviceUrl": "http://echoapi.cloudapp.net/api", "path": "echo", - "isCurrent": true + "apiRevision": "1", + "id": "/apis/echo-api", + "isCurrent": true, + "serviceUrl": "http://echoapi.cloudapp.net/api" + }, + "tag": { + "name": "awesomeTag", + "id": "/tags/apitag123" } } - ], - "count": 1 + ] } } - } + }, + "operationId": "Api_ListByTags", + "title": "ApiManagementListApisByTags" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationAccessPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationAccessPolicies.json index ca5358ee87d2..b1e67999d40d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationAccessPolicies.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationAccessPolicies.json @@ -1,43 +1,45 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "authorizationId": "authz1", "authorizationProviderId": "aadwithauthcode", - "authorizationId": "authz1" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies", - "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies/fe0bed83-631f-4149-bd0b-0464b1bc7cab", "properties": { "appIds": [ "d5f04bb0-ba78-4878-a43e-35a0b74fe315" ], - "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff", - "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab" + "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab", + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies", - "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", "name": "5585d6cd-2289-42e9-ab9b-3e2e23d74b4a", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies/5585d6cd-2289-42e9-ab9b-3e2e23d74b4a", "properties": { "appIds": [ "d5f04bb0-ba78-4878-a43e-35a0b74fe315" ], - "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff", - "objectId": "5585d6cd-2289-42e9-ab9b-3e2e23d74b4a" + "objectId": "5585d6cd-2289-42e9-ab9b-3e2e23d74b4a", + "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff" } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "AuthorizationAccessPolicy_ListByAuthorization", + "title": "ApiManagementListAuthorizationAccessPolicies" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationProviders.json index ec20c4a18623..53a5cc27f2af 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationProviders.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationProviders.json @@ -1,97 +1,99 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", - "type": "Microsoft.ApiManagement/service/authorizationProviders", "name": "aadwithauthcode", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode", "properties": { "displayName": "aadwithauthcode", "identityProvider": "aad", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "authorizationCode": { "clientId": "53790825-fdd3-4b80-bc7a-4c3aaf25801d", - "scopes": "User.Read.All Group.Read.All", "loginUri": "https://login.windows.net", "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All", "tenantId": "common" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred", - "type": "Microsoft.ApiManagement/service/authorizationProviders", "name": "aadwithclientcred", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred", "properties": { "displayName": "aadwithclientcred", "identityProvider": "aad", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "clientCredentials": { - "scopes": "User.Read.All Group.Read.All", "loginUri": "https://login.windows.net", "resourceUri": "https://graph.microsoft.com", + "scopes": "User.Read.All Group.Read.All", "tenantId": "common" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/google", - "type": "Microsoft.ApiManagement/service/authorizationProviders", "name": "google", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/google", "properties": { "displayName": "google", "identityProvider": "google", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "authorizationCode": { "clientId": "99999999-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com", "scopes": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/eventbrite", - "type": "Microsoft.ApiManagement/service/authorizationProviders", "name": "eventbrite", + "type": "Microsoft.ApiManagement/service/authorizationProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/eventbrite", "properties": { "displayName": "eventbrite", "identityProvider": "oauth2", "oauth2": { - "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1", "grantTypes": { "authorizationCode": { - "clientId": "clientid", - "scopes": null, "authorizationUrl": "https://www.eventbrite.com/oauth/authorize", + "clientId": "clientid", "refreshUrl": "https://www.eventbrite.com/oauth/token", + "scopes": null, "tokenUrl": "https://www.eventbrite.com/oauth/token" } - } + }, + "redirectUrl": "https://authorization-manager.consent.azure-apim.net/redirect/apim/apimService1" } } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "AuthorizationProvider_ListByService", + "title": "ApiManagementListAuthorizationProviders" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationServers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationServers.json index 523353bf5bc5..dcb49c805862 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationServers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationServers.json @@ -1,78 +1,80 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", - "type": "Microsoft.ApiManagement/service/authorizationServers", "name": "newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", "properties": { - "displayName": "test2", - "useInTestConsole": true, - "useInApiDocumentation": false, "description": "test server", - "clientRegistrationEndpoint": "https://www.contoso.com/apps", "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", "authorizationMethods": [ "GET" ], - "tokenEndpoint": "https://www.contoso.com/oauth2/token", - "supportState": true, + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", "defaultScope": "read write", + "displayName": "test2", "grantTypes": [ "authorizationCode", "implicit" ], - "bearerTokenSendingMethods": [ - "authorizationHeader" - ], - "clientId": "1", + "resourceOwnerPassword": "pwd", "resourceOwnerUsername": "un", - "resourceOwnerPassword": "pwd" + "supportState": true, + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "useInApiDocumentation": false, + "useInTestConsole": true } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer2", - "type": "Microsoft.ApiManagement/service/authorizationServers", "name": "newauthServer2", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer2", "properties": { - "displayName": "test3", - "useInTestConsole": false, - "useInApiDocumentation": true, "description": "test server", - "clientRegistrationEndpoint": "https://www.contoso.com/apps", "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", "authorizationMethods": [ "GET" ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], "clientAuthenticationMethod": [ "Basic" ], - "tokenEndpoint": "https://www.contoso.com/oauth2/token", - "supportState": true, + "clientId": "1", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", "defaultScope": "read write", + "displayName": "test3", "grantTypes": [ "authorizationCode", "implicit" ], - "bearerTokenSendingMethods": [ - "authorizationHeader" - ], - "clientId": "1", + "resourceOwnerPassword": "pwd", "resourceOwnerUsername": "un", - "resourceOwnerPassword": "pwd" + "supportState": true, + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "useInApiDocumentation": true, + "useInTestConsole": false } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "AuthorizationServer_ListByService", + "title": "ApiManagementListAuthorizationServers" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationsAuthCode.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationsAuthCode.json index 09a8a95fe2cc..0e7b99220d91 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationsAuthCode.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationsAuthCode.json @@ -1,19 +1,20 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "authorizationProviderId": "aadwithauthcode" + "authorizationProviderId": "aadwithauthcode", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1", - "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", "name": "authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1", "properties": { "authorizationType": "OAuth2", "oauth2grantType": "AuthorizationCode", @@ -21,22 +22,23 @@ } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz2", - "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", "name": "authz2", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz2", "properties": { "authorizationType": "OAuth2", - "oauth2grantType": "AuthorizationCode", - "status": "Error", "error": { "code": "Unauthenticated", "message": "This connection is not authenticated." - } + }, + "oauth2grantType": "AuthorizationCode", + "status": "Error" } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "Authorization_ListByAuthorizationProvider", + "title": "ApiManagementListAuthorizationsAuthCode" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationsClientCred.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationsClientCred.json index f996c5048f3d..de9cd115ec59 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationsClientCred.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListAuthorizationsClientCred.json @@ -1,19 +1,20 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "authorizationProviderId": "aadwithclientcred" + "authorizationProviderId": "aadwithclientcred", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz1", - "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", "name": "authz1", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz1", "properties": { "authorizationType": "OAuth2", "oauth2grantType": "ClientCredentials", @@ -24,25 +25,26 @@ } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz2", - "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", "name": "authz2", + "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithclientcred/authorizations/authz2", "properties": { "authorizationType": "OAuth2", + "error": { + "code": "Unauthorized", + "message": "Failed to acquire access token for service using client credentials flow: IdentityProvider=aadwithclientcred. Correlation Id=6299d09b-03b7-46ed-b355-0453451d7e49, UTC TimeStamp=5/14/2022 4:53:19 PM, Error: Failed to exchange client credentials for token. Response code=Unauthorized, Details:\r\n{\"error\":\"invalid_client\",\"error_description\":\"AADSTS7000215: Invalid client secret provided. Ensure the secret being sent in the request is the client secret value, not the client secret ID, for a secret added to app 'clientsecretid'.\\r\\nTrace ID: 4a18d3cd-9ad5-4664-b3eb-daaa2f435f00\\r\\nCorrelation ID: dde60c16-35cb-4572-8226-bfb4233af8d7\\r\\nTimestamp: 2022-05-14 16:53:19Z\",\"error_codes\":[7000215],\"timestamp\":\"2022-05-14 16:53:19Z\",\"trace_id\":\"4a18d3cd-9ad5-4664-b3eb-daaa2f435f00\",\"correlation_id\":\"dde60c16-35cb-4572-8226-bfb4233af8d7\",\"error_uri\":\"https://login.windows.net/error?code=7000215\"}" + }, "oauth2grantType": "ClientCredentials", "parameters": { "clientId": "clientsecretid" }, - "status": "Error", - "error": { - "code": "Unauthorized", - "message": "Failed to acquire access token for service using client credentials flow: IdentityProvider=aadwithclientcred. Correlation Id=6299d09b-03b7-46ed-b355-0453451d7e49, UTC TimeStamp=5/14/2022 4:53:19 PM, Error: Failed to exchange client credentials for token. Response code=Unauthorized, Details:\r\n{\"error\":\"invalid_client\",\"error_description\":\"AADSTS7000215: Invalid client secret provided. Ensure the secret being sent in the request is the client secret value, not the client secret ID, for a secret added to app 'clientsecretid'.\\r\\nTrace ID: 4a18d3cd-9ad5-4664-b3eb-daaa2f435f00\\r\\nCorrelation ID: dde60c16-35cb-4572-8226-bfb4233af8d7\\r\\nTimestamp: 2022-05-14 16:53:19Z\",\"error_codes\":[7000215],\"timestamp\":\"2022-05-14 16:53:19Z\",\"trace_id\":\"4a18d3cd-9ad5-4664-b3eb-daaa2f435f00\",\"correlation_id\":\"dde60c16-35cb-4572-8226-bfb4233af8d7\",\"error_uri\":\"https://login.windows.net/error?code=7000215\"}" - } + "status": "Error" } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "Authorization_ListByAuthorizationProvider", + "title": "ApiManagementListAuthorizationsClientCred" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListBackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListBackends.json index 60a16a9285eb..12598e33bbeb 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListBackends.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListBackends.json @@ -1,29 +1,26 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", - "type": "Microsoft.ApiManagement/service/backends", "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", "properties": { "description": "description5308", - "url": "https://backendname2644/", - "protocol": "http", "credentials": { - "query": { - "sv": [ - "xx", - "bb", - "cc" - ] + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" }, "header": { "x-my-1": [ @@ -31,51 +28,56 @@ "val2" ] }, - "authorization": { - "scheme": "Basic", - "parameter": "opensesma" + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] } }, "proxy": { + "password": "", "url": "http://192.168.1.1:8080", - "username": "Contoso\\admin", - "password": "" + "username": "Contoso\\admin" }, "tls": { "validateCertificateChain": false, "validateCertificateName": false - } + }, + "url": "https://backendname2644/", + "protocol": "http" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", - "type": "Microsoft.ApiManagement/service/backends", "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", "properties": { "description": "Service Fabric Test App 1", - "url": "fabric:/mytestapp/mytestservice", - "protocol": "http", "properties": { "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", "managementEndpoints": [ "https://somecluster.com" ], - "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "maxPartitionResolutionRetries": 5, "serverX509Names": [ { "name": "ServerCommonName1", "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" } - ], - "maxPartitionResolutionRetries": 5 + ] } - } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" } } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "Backend_ListByService", + "title": "ApiManagementListBackends" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListCaches.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListCaches.json index ef8b38ed4009..1137e89b8db4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListCaches.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListCaches.json @@ -1,28 +1,30 @@ { "parameters": { + "api-version": "2024-10-01-preview", "resourceGroupName": "rg1", "serviceName": "apimService1", - "api-version": "2024-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", - "type": "Microsoft.ApiManagement/service/caches", "name": "c1", + "type": "Microsoft.ApiManagement/service/caches", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", "properties": { - "useFromLocation": "default", "description": "Redis cache instances in West India", "connectionString": "{{5f7fbca77a891a2200f3db38}}", - "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1" + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1", + "useFromLocation": "default" } } - ], - "count": 1 + ] } } - } + }, + "operationId": "Cache_ListByService", + "title": "ApiManagementListCaches" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListCertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListCertificates.json index d80a1e3edab8..aaa39a662b09 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListCertificates.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListCertificates.json @@ -1,46 +1,48 @@ { "parameters": { + "api-version": "2024-10-01-preview", "resourceGroupName": "rg1", "serviceName": "apimService1", - "api-version": "2024-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/kjoshiarmtemplateCert1", - "type": "Microsoft.ApiManagement/service/certificates", "name": "templateCert1", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/kjoshiarmtemplateCert1", "properties": { + "expirationDate": "2017-04-23T17:03:41Z", "subject": "CN=mutual-authcert", - "thumbprint": "EBA************************48594A6", - "expirationDate": "2017-04-23T17:03:41Z" + "thumbprint": "EBA************************48594A6" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", - "type": "Microsoft.ApiManagement/service/certificates", "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", "properties": { - "subject": "CN=*.msitesting.net", - "thumbprint": "EA**********************9AD690", "expirationDate": "2037-01-01T07:00:00Z", "keyVault": { - "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-22T00:24:53.3191468Z" - } - } + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" } } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "Certificate_ListByService", + "title": "ApiManagementListCertificates" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListClientApplicationProductLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListClientApplicationProductLinks.json index 9573c28a03c9..e7168cb37366 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListClientApplicationProductLinks.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListClientApplicationProductLinks.json @@ -1,42 +1,44 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "clientApplicationId": "testAppId" + "clientApplicationId": "testAppId", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link1", - "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link1", "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link2", - "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", "name": "link2", + "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link2", "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link3", - "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", "name": "link3", + "type": "Microsoft.ApiManagement/service/clientApplications/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId/productLinks/link3", "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/premium" } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "ClientApplicationProductLink_ListByClientApplications", + "title": "ApiManagementListProducts" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListClientApplicationSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListClientApplicationSecrets.json index 8700602982d3..d7c556e65c54 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListClientApplicationSecrets.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListClientApplicationSecrets.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "clientApplicationId": "testAppId" + "clientApplicationId": "testAppId", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -15,5 +15,7 @@ } } } - } + }, + "operationId": "ClientApplication_ListSecrets", + "title": "ApiManagementListProducts" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListClientApplications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListClientApplications.json index 261ef94ca5dc..fce38a48ca9e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListClientApplications.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListClientApplications.json @@ -1,56 +1,58 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId", - "type": "Microsoft.ApiManagement/service/clientApplications", "name": "testAppId", + "type": "Microsoft.ApiManagement/service/clientApplications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId", "properties": { - "displayName": "Test Application", - "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userID1", - "state": "active", "description": "This is just an example application", + "displayName": "Test Application", "entraApplicationId": "00000000-0000-0000-0000-000000000000", - "entraTenantId": "00000000-0000-0000-0000-000000000010" + "entraTenantId": "00000000-0000-0000-0000-000000000010", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userID1", + "state": "active" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId2", - "type": "Microsoft.ApiManagement/service/clientApplications", "name": "testAppId2", + "type": "Microsoft.ApiManagement/service/clientApplications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId2", "properties": { - "displayName": "Test Application 2", - "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userID2", - "state": "active", "description": "This is just an example application 2", + "displayName": "Test Application 2", "entraApplicationId": "00000000-0000-0000-0000-000000000001", - "entraTenantId": "00000000-0000-0000-0000-000000000011" + "entraTenantId": "00000000-0000-0000-0000-000000000011", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userID2", + "state": "active" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId3", - "type": "Microsoft.ApiManagement/service/clientApplications", "name": "testAppId3", + "type": "Microsoft.ApiManagement/service/clientApplications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/clientApplications/testAppId3", "properties": { - "displayName": "Test Application 3", - "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userID1", - "state": "active", "description": "This is just an example application 3", + "displayName": "Test Application 3", "entraApplicationId": "00000000-0000-0000-0000-000000000002", - "entraTenantId": "00000000-0000-0000-0000-000000000012" + "entraTenantId": "00000000-0000-0000-0000-000000000012", + "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userID1", + "state": "active" } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "ClientApplication_ListByService", + "title": "ApiManagementListProducts" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListContentTypeContentItems.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListContentTypeContentItems.json index f4ac40ab3a23..30685eab88a4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListContentTypeContentItems.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListContentTypeContentItems.json @@ -1,31 +1,33 @@ { "parameters": { + "api-version": "2024-10-01-preview", + "contentTypeId": "page", "resourceGroupName": "rg1", "serviceName": "apimService1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "contentTypeId": "page" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "value": [ { - "id": "/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", - "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", "name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", + "type": "Microsoft.ApiManagement/service/contentTypes/contentItems", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", "properties": { "en_us": { - "title": "About", "description": "Short story about the company.", - "keywords": "company, about", "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", - "permalink": "/about" + "keywords": "company, about", + "permalink": "/about", + "title": "About" } } } ] } } - } + }, + "operationId": "ContentItem_ListByService", + "title": "ApiManagementListContentTypeContentItems" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListContentTypes.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListContentTypes.json index 24b1450e92ab..55667b0142b4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListContentTypes.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListContentTypes.json @@ -1,8 +1,8 @@ { "parameters": { + "api-version": "2024-10-01-preview", "resourceGroupName": "rg1", "serviceName": "apimService1", - "api-version": "2024-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -10,62 +10,64 @@ "body": { "value": [ { - "id": "/contentTypes/page", - "type": "Microsoft.ApiManagement/service/contentTypes", "name": "page", + "type": "Microsoft.ApiManagement/service/contentTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/contentTypes/page", "properties": { "name": "Page", - "description": "A regular page", "schema": { + "additionalProperties": false, "properties": { "en_us": { "type": "object", + "additionalProperties": false, "properties": { - "title": { - "title": "Title", - "description": "Page title. This property gets included in SEO attributes.", - "type": "string", - "indexed": true - }, "description": { - "title": "Description", + "type": "string", "description": "Page description. This property gets included in SEO attributes.", + "indexed": true, + "title": "Description" + }, + "documentId": { "type": "string", - "indexed": true + "description": "Reference to page content document.", + "title": "Document ID" }, "keywords": { - "title": "Keywords", - "description": "Page keywords. This property gets included in SEO attributes.", "type": "string", - "indexed": true + "description": "Page keywords. This property gets included in SEO attributes.", + "indexed": true, + "title": "Keywords" }, "permalink": { - "title": "Permalink", - "description": "Page permalink, e.g. '/about'.", "type": "string", - "indexed": true + "description": "Page permalink, e.g. '/about'.", + "indexed": true, + "title": "Permalink" }, - "documentId": { - "title": "Document ID", - "description": "Reference to page content document.", - "type": "string" + "title": { + "type": "string", + "description": "Page title. This property gets included in SEO attributes.", + "indexed": true, + "title": "Title" } }, - "additionalProperties": false, "required": [ "title", "permalink", "documentId" ] } - }, - "additionalProperties": false + } }, + "description": "A regular page", "version": "1.0.0" } } ] } } - } + }, + "operationId": "ContentType_ListByService", + "title": "ApiManagementListContentTypes" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListDiagnostics.json index 024b5ad20e61..a7484a808875 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListDiagnostics.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListDiagnostics.json @@ -1,74 +1,76 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "httpCorrelationProtocol": "Legacy", - "verbosity": "information", - "logClientIp": true, - "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", - "sampling": { - "samplingType": "fixed", - "percentage": 100 - }, - "frontend": { - "request": { - "headers": [], + "backend": { + "response": { "body": { "bytes": 0 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 0 - } + }, + "headers": [] } }, - "backend": { - "request": { - "headers": [], + "frontend": { + "response": { "body": { "bytes": 0 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 0 - } + }, + "headers": [] } - } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" + }, + "verbosity": "information" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/azuremonitor", - "type": "Microsoft.ApiManagement/service/diagnostics", "name": "azuremonitor", + "type": "Microsoft.ApiManagement/service/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/azuremonitor", "properties": { "logClientIp": true, "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor", "sampling": { - "samplingType": "fixed", - "percentage": 100 + "percentage": 100, + "samplingType": "fixed" } } } - ], - "count": 1 + ] } } - } + }, + "operationId": "Diagnostic_ListByService", + "title": "ApiManagementListDiagnostics" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListDocumentations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListDocumentations.json index c485fcaa2347..5740f5687536 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListDocumentations.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListDocumentations.json @@ -1,44 +1,46 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test", - "type": "Microsoft.ApiManagement/service/documentations", "name": "test", + "type": "Microsoft.ApiManagement/service/documentations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test", "properties": { - "title": "test", - "content": "Test content " + "content": "Test content ", + "title": "test" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test2", - "type": "Microsoft.ApiManagement/service/documentations", "name": "test2", + "type": "Microsoft.ApiManagement/service/documentations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test2", "properties": { - "title": "test", - "content": "Test content " + "content": "Test content ", + "title": "test" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test3", - "type": "Microsoft.ApiManagement/service/documentations", "name": "test3", + "type": "Microsoft.ApiManagement/service/documentations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test3", "properties": { - "title": "test", - "content": "Test content " + "content": "Test content ", + "title": "test" } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "Documentation_ListByService", + "title": "ApiManagementListApis" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayApis.json index 2979b88be0f3..082d16e59891 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayApis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayApis.json @@ -1,35 +1,37 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "gatewayId": "gw1" + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/57681820a40f7eb6c49f6aca", - "type": "Microsoft.ApiManagement/service/gateways/apis", "name": "57681820a40f7eb6c49f6aca", + "type": "Microsoft.ApiManagement/service/gateways/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/57681820a40f7eb6c49f6aca", "properties": { - "displayName": "api_57681820a40f7eb6c49f6acb", - "apiRevision": "1", - "description": "description_57681820a40f7eb6c49f6acc", - "serviceUrl": "http://contoso/57681820a40f7eb6c49f6acd", "path": "suffix_57681820a40f7eb6c49f6ace", + "description": "description_57681820a40f7eb6c49f6acc", + "apiRevision": "1", + "displayName": "api_57681820a40f7eb6c49f6acb", + "isCurrent": true, "protocols": [ "https" ], - "isCurrent": true + "serviceUrl": "http://contoso/57681820a40f7eb6c49f6acd" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "GatewayApi_ListByService", + "title": "ApiManagementListGatewayApis" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayCertificateAuthorities.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayCertificateAuthorities.json index 99ed33448916..33bc18c853ed 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayCertificateAuthorities.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayCertificateAuthorities.json @@ -1,34 +1,36 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "gatewayId": "gw1" + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", - "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", "name": "cert1", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1", "properties": { "isTrusted": false } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert2", - "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", "name": "cert2", + "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert2", "properties": { "isTrusted": true } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "GatewayCertificateAuthority_ListByService", + "title": "ApiManagementListGatewaycertificateAuthorities" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayConfigConnection.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayConfigConnection.json index e9062c426cdb..73ee3a1a21aa 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayConfigConnection.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayConfigConnection.json @@ -1,41 +1,43 @@ { "parameters": { - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "gatewayName": "standard-gw-1" + "gatewayName": "standard-gw-1", + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", "name": "gcc-1", "type": "Microsoft.ApiManagement/gateways/configConnections", "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1", "properties": { - "provisioningState": "Succeeded", - "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001", "defaultHostname": "gcc-1-ahg4t5iof8gaafex.standard-gw-1.gateway.eastus.azure-api.net", "hostnames": [ "gcc1standard-gw-1.gateway.eastus.azure-api.net" - ] + ], + "provisioningState": "Succeeded", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001" } }, { + "name": "gcc-2", + "type": "Microsoft.ApiManagement/gateways/configConnetions", "etag": "AAAAAAAWKwo=", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-2", - "name": "gcc-2", "properties": { + "defaultHostname": "gcc-2-ahg4t5iof8gaafex.standard-gw-1.gateway.eastus.azure-api.net", "provisioningState": "Succeeded", - "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-002", - "defaultHostname": "gcc-2-ahg4t5iof8gaafex.standard-gw-1.gateway.eastus.azure-api.net" - }, - "type": "Microsoft.ApiManagement/gateways/configConnetions" + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-002" + } } ] } } - } + }, + "operationId": "ApiGatewayConfigConnection_ListByGateway", + "title": "ApiManagementListGatewayConfigConnection" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayHostnameConfigurations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayHostnameConfigurations.json index 3cc2393eab3f..f4b55177be43 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayHostnameConfigurations.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewayHostnameConfigurations.json @@ -1,38 +1,40 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "gatewayId": "gw1" + "gatewayId": "gw1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", - "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", "name": "default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default", "properties": { - "hostname": "*", "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1", + "hostname": "*", "negotiateClientCertificate": false } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/hostname1", - "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", "name": "default", + "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/hostname1", "properties": { - "hostname": "foo.bar.com", "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert2", + "hostname": "foo.bar.com", "negotiateClientCertificate": true } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "GatewayHostnameConfiguration_ListByService", + "title": "ApiManagementListGatewayHostnameConfigurations" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGateways.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGateways.json index 8f48ce432317..7eca412c25db 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGateways.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGateways.json @@ -1,18 +1,20 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", - "type": "Microsoft.ApiManagement/service/gateways", "name": "a1", + "type": "Microsoft.ApiManagement/service/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", "properties": { "description": "my gateway 1", "locationData": { @@ -21,9 +23,9 @@ } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw2", - "type": "Microsoft.ApiManagement/service/gateways", "name": "5a73933b8f27f7cc82a2d533", + "type": "Microsoft.ApiManagement/service/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw2", "properties": { "description": "my gateway 2", "locationData": { @@ -31,10 +33,10 @@ } } } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "Gateway_ListByService", + "title": "ApiManagementListGateways" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewaysBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewaysBySubscription.json index f69c10950211..dec393035c0f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewaysBySubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewaysBySubscription.json @@ -8,22 +8,12 @@ "body": { "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1", "name": "standard-gw-1", "type": "Microsoft.ApiManagement/gateways", - "tags": { - "owner": "v-aswmoh", - "ReleaseName": "Z3" - }, - "location": "West US", "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1", + "location": "West US", "properties": { - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2021-06-16T09:40:00.9453556Z", - "frontend": { - "defaultHostname": "standard-gw-1.westus.gateway.azure-api.net" - }, "backend": { "subnet": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" @@ -31,42 +21,54 @@ }, "configurationApi": { "hostname": "standard-gw-1.westus.configuration.gateway.azure-api.net" - } + }, + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "frontend": { + "defaultHostname": "standard-gw-1.westus.gateway.azure-api.net" + }, + "provisioningState": "Succeeded", + "targetProvisioningState": "" }, "sku": { "name": "Standard", "capacity": 1 }, "systemData": { + "createdAt": "2021-06-16T09:40:00.7106733Z", "createdBy": "bar@contoso.com", "createdByType": "User", - "createdAt": "2021-06-16T09:40:00.7106733Z", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z", "lastModifiedBy": "foo@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-06-20T06:33:09.6159006Z" + "lastModifiedByType": "User" + }, + "tags": { + "ReleaseName": "Z3", + "owner": "v-aswmoh" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg2/providers/Microsoft.ApiManagement/gateways/workspace-gw-2", "name": "workspace-gw-2", "type": "Microsoft.ApiManagement/gateways", - "tags": { - "Owner": "foo" - }, - "location": "East US", "etag": "AAAAAAAWKwo=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg2/providers/Microsoft.ApiManagement/gateways/workspace-gw-2", + "location": "East US", "properties": { + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2021-06-16T09:40:00.9453556Z" + "targetProvisioningState": "" }, "sku": { "name": "WorkspaceGatewayPremium", "capacity": 1 + }, + "tags": { + "Owner": "foo" } } ] } } - } + }, + "operationId": "ApiGateway_List", + "title": "ApiManagementListGatewaysBySubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewaysBySubscriptionAndResourceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewaysBySubscriptionAndResourceGroup.json index 28f963359eae..5206e3339327 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewaysBySubscriptionAndResourceGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGatewaysBySubscriptionAndResourceGroup.json @@ -1,7 +1,7 @@ { "parameters": { - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -9,22 +9,12 @@ "body": { "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1", "name": "standard-gw-1", "type": "Microsoft.ApiManagement/gateways", - "tags": { - "owner": "v-aswmoh", - "ReleaseName": "Z3" - }, - "location": "West US", "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1", + "location": "West US", "properties": { - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2021-06-16T09:40:00.9453556Z", - "frontend": { - "defaultHostname": "standard-gw-1.westus.gateway.azure-api.net" - }, "backend": { "subnet": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" @@ -32,37 +22,38 @@ }, "configurationApi": { "hostname": "standard-gw-1.westus.configuration.gateway.azure-api.net" - } + }, + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "frontend": { + "defaultHostname": "standard-gw-1.westus.gateway.azure-api.net" + }, + "provisioningState": "Succeeded", + "targetProvisioningState": "" }, "sku": { "name": "Standard", "capacity": 1 }, "systemData": { + "createdAt": "2021-06-16T09:40:00.7106733Z", "createdBy": "bar@contoso.com", "createdByType": "User", - "createdAt": "2021-06-16T09:40:00.7106733Z", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z", "lastModifiedBy": "foo@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-06-20T06:33:09.6159006Z" + "lastModifiedByType": "User" + }, + "tags": { + "ReleaseName": "Z3", + "owner": "v-aswmoh" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-2", "name": "standard-gw-2", "type": "Microsoft.ApiManagement/gateways", - "tags": { - "Owner": "vitaliik" - }, - "location": "East US", "etag": "AAAAAAAWKwo=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-2", + "location": "East US", "properties": { - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2021-06-16T09:40:00.9453556Z", - "frontend": { - "defaultHostname": "standard-gw-2.eastus.gateway.azure-api.net" - }, "backend": { "subnet": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn2/subnets/sn2" @@ -70,15 +61,26 @@ }, "configurationApi": { "hostname": "standard-gw-2.eastus.configuration.gateway.azure-api.net" - } + }, + "createdAtUtc": "2021-06-16T09:40:00.9453556Z", + "frontend": { + "defaultHostname": "standard-gw-2.eastus.gateway.azure-api.net" + }, + "provisioningState": "Succeeded", + "targetProvisioningState": "" }, "sku": { "name": "Standard", "capacity": 1 + }, + "tags": { + "Owner": "vitaliik" } } ] } } - } + }, + "operationId": "ApiGateway_ListByResourceGroup", + "title": "ApiManagementListGatewaysBySubscriptionAndResourceGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGlobalSchemas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGlobalSchemas.json index 6d093b46ef44..ca839941ed32 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGlobalSchemas.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGlobalSchemas.json @@ -1,18 +1,20 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", - "type": "Microsoft.ApiManagement/service/schemas", "name": "schema1", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1", "properties": { "description": "sample schema description", "schemaType": "xml", @@ -20,18 +22,21 @@ } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema2", - "type": "Microsoft.ApiManagement/service/schemas", "name": "schema2", + "type": "Microsoft.ApiManagement/service/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema2", "properties": { "description": "sample schema description", - "schemaType": "json", "document": { + "type": "object", "$id": "https://example.com/person.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "Person", - "type": "object", "properties": { + "age": { + "type": "integer", + "description": "Age in years which must be equal to or greater than zero.", + "minimum": 0 + }, "firstName": { "type": "string", "description": "The person's first name." @@ -39,20 +44,17 @@ "lastName": { "type": "string", "description": "The person's last name." - }, - "age": { - "description": "Age in years which must be equal to or greater than zero.", - "type": "integer", - "minimum": 0 } - } - } + }, + "title": "Person" + }, + "schemaType": "json" } } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "GlobalSchema_ListByService", + "title": "ApiManagementListSchemas" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGraphQLApiResolverPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGraphQLApiResolverPolicies.json index 57dc991b7d00..657c236be51e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGraphQLApiResolverPolicies.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGraphQLApiResolverPolicies.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "599e2953193c3c0bd0b3e2fa", - "resolverId": "599e29ab193c3c0bd0b3e2fb" + "resolverId": "599e29ab193c3c0bd0b3e2fb", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/599e2953193c3c0bd0b3e2fa/resolvers/599e29ab193c3c0bd0b3e2fb/policies/policy", - "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/apis/resolvers/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/599e2953193c3c0bd0b3e2fa/resolvers/599e29ab193c3c0bd0b3e2fb/policies/policy", "properties": { "value": "\r\n\r\n \r\n GET\r\n\r\n/api/users \r\n \r\n \r\n \r\n \r\n \r\n { \"id\": \"{{body.id}}\" } \r\n" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "GraphQLApiResolverPolicy_ListByResolver", + "title": "ApiManagementListGraphQLApiResolverPolicies" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGraphQLApiResolvers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGraphQLApiResolvers.json index 560930766535..1d114a794fe7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGraphQLApiResolvers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGraphQLApiResolvers.json @@ -1,50 +1,52 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d2ef278aa04f0888cba3f3", - "resolverId": "57d2ef278aa04f0ad01d6cdc" + "resolverId": "57d2ef278aa04f0ad01d6cdc", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/apis/resolvers", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc", "properties": { - "displayName": "Query Users", "path": "Query/users", - "description": "A GraphQL Resolver example" + "description": "A GraphQL Resolver example", + "displayName": "Query Users" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cda", - "type": "Microsoft.ApiManagement/service/apis/resolvers", "name": "57d2ef278aa04f0ad01d6cda", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cda", "properties": { - "displayName": "Mutation makeUser", "path": "Mutation/makeUser", - "description": "A GraphQL Resolver example" + "description": "A GraphQL Resolver example", + "displayName": "Mutation makeUser" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cd9", - "type": "Microsoft.ApiManagement/service/apis/resolvers", "name": "57d2ef278aa04f0ad01d6cd9", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cd9", "properties": { - "displayName": "Query for User Id field", "path": "User/id", - "description": "A GraphQL Resolver example" + "description": "A GraphQL Resolver example", + "displayName": "Query for User Id field" } } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "GraphQLApiResolver_ListByApi", + "title": "ApiManagementListGraphQLApiResolvers" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGroupUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGroupUsers.json index aab513405014..4b468c922b5b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGroupUsers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGroupUsers.json @@ -1,38 +1,40 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "groupId": "57d2ef278aa04f0888cba3f3" + "groupId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/kjoshiarmTemplateUser1", - "type": "Microsoft.ApiManagement/service/groups/users", "name": "armTemplateUser1", + "type": "Microsoft.ApiManagement/service/groups/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/kjoshiarmTemplateUser1", "properties": { - "firstName": "user1", - "lastName": "lastname1", "email": "user1@live.com", - "state": "active", - "registrationDate": "2017-05-31T18:54:41.447Z", - "note": "note for user 1", + "firstName": "user1", "identities": [ { - "provider": "Basic", - "id": "user1@live.com" + "id": "user1@live.com", + "provider": "Basic" } - ] + ], + "lastName": "lastname1", + "note": "note for user 1", + "registrationDate": "2017-05-31T18:54:41.447Z", + "state": "active" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "GroupUser_List", + "title": "ApiManagementListGroupUsers" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGroups.json index 052f15b2c4c9..dbb78ba80031 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGroups.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListGroups.json @@ -1,63 +1,65 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 4, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020001", - "type": "Microsoft.ApiManagement/service/groups", "name": "5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020001", "properties": { - "displayName": "Administrators", + "type": "system", "description": "Administrators is a built-in group. Its membership is managed by the system. Microsoft Azure subscription administrators fall into this group.", "builtIn": true, - "type": "system" + "displayName": "Administrators" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9", - "type": "Microsoft.ApiManagement/service/groups", "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9", "properties": { - "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "type": "external", "description": "awesome group of people", "builtIn": false, - "type": "external", + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020002", - "type": "Microsoft.ApiManagement/service/groups", "name": "5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020002", "properties": { - "displayName": "Developers", + "type": "system", "description": "Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.", "builtIn": true, - "type": "system" + "displayName": "Developers" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020003", - "type": "Microsoft.ApiManagement/service/groups", "name": "5600b59375ff190048020003", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020003", "properties": { - "displayName": "Guests", + "type": "system", "description": "Guests is a built-in group. Its membership is managed by the system. Unauthenticated users visiting the developer portal fall into this group.", "builtIn": true, - "type": "system" + "displayName": "Guests" } } - ], - "count": 4, - "nextLink": "" + ] } } - } + }, + "operationId": "Group_ListByService", + "title": "ApiManagementListGroups" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListIdentityProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListIdentityProviders.json index 7331f43e3478..7ad16fc2b755 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListIdentityProviders.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListIdentityProviders.json @@ -1,53 +1,55 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Google", - "type": "Microsoft.ApiManagement/service/identityProviders", "name": "Google", + "type": "Microsoft.ApiManagement/service/identityProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Google", "properties": { - "clientId": "googleId", - "type": "google" + "type": "google", + "clientId": "googleId" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Aad", - "type": "Microsoft.ApiManagement/service/identityProviders", "name": "Aad", + "type": "Microsoft.ApiManagement/service/identityProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Aad", "properties": { - "clientId": "aadapplicationid", "type": "aad", "allowedTenants": [ "samiraad.onmicrosoft.com" - ] + ], + "clientId": "aadapplicationid" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C", - "type": "Microsoft.ApiManagement/service/identityProviders", "name": "AadB2C", + "type": "Microsoft.ApiManagement/service/identityProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C", "properties": { - "clientId": "aadb2clientId", "type": "aadB2C", "allowedTenants": [ "samirtestbc.onmicrosoft.com" ], - "signupPolicyName": "B2C_1_Signup_Default", - "signinPolicyName": "B2C_1_Signin_Default" + "clientId": "aadb2clientId", + "signinPolicyName": "B2C_1_Signin_Default", + "signupPolicyName": "B2C_1_Signup_Default" } } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "IdentityProvider_ListByService", + "title": "ApiManagementListIdentityProviders" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListIssues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListIssues.json index 9f775b8a13ce..446a9391a7a5 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListIssues.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListIssues.json @@ -1,31 +1,33 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/issues", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/issues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues/57d2ef278aa04f0ad01d6cdc", "properties": { - "title": "New API issue", "description": "New API issue description", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", "createdDate": "2018-02-01T22:21:20.467Z", "state": "open", - "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", - "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a" + "title": "New API issue", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "Issue_ListByService", + "title": "ApiManagementListIssues" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListLoggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListLoggers.json index 0f2183b60502..6303baf9695e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListLoggers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListLoggers.json @@ -1,52 +1,54 @@ { "parameters": { + "api-version": "2024-10-01-preview", "resourceGroupName": "rg1", "serviceName": "apimService1", - "api-version": "2024-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor", - "type": "Microsoft.ApiManagement/service/loggers", "name": "azuremonitor", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor", "properties": { - "loggerType": "azureMonitor", - "isBuffered": true + "isBuffered": true, + "loggerType": "azureMonitor" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/vvktest", - "type": "Microsoft.ApiManagement/service/loggers", "name": "vvktest", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/vvktest", "properties": { - "loggerType": "applicationInsights", "credentials": { "instrumentationKey": "{{Logger-Credentials-5b1a17ef2b3f91153004b10d}}" }, - "isBuffered": true + "isBuffered": true, + "loggerType": "applicationInsights" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/applicationinsights", - "type": "Microsoft.ApiManagement/service/loggers", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/applicationinsights", "properties": { - "loggerType": "applicationInsights", "description": "miaoappinsight", "credentials": { "instrumentationKey": "{{Logger-Credentials-5b2056062b3f911ae84a3069}}" }, - "isBuffered": true + "isBuffered": true, + "loggerType": "applicationInsights" } } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "Logger_ListByService", + "title": "ApiManagementListLoggers" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNamedValues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNamedValues.json index 4da327de6e2f..8d16c4739ec2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNamedValues.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNamedValues.json @@ -1,49 +1,51 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/592f1174cc83890dc4f32686", - "type": "Microsoft.ApiManagement/service/namedValues", "name": "592f1174cc83890dc4f32686", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/592f1174cc83890dc4f32686", "properties": { "displayName": "Logger-Credentials-592f1174cc83890dc4f32687", - "value": "propValue", - "secret": false + "secret": false, + "value": "propValue" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", - "type": "Microsoft.ApiManagement/service/namedValues", "name": "testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", "properties": { "displayName": "prop6namekv", "keyVault": { - "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret", "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-11T00:54:31.8024882Z" - } + }, + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" }, + "secret": true, "tags": [ "foo", "bar" - ], - "secret": true + ] } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "NamedValue_ListByService", + "title": "ApiManagementListNamedValues" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNotificationRecipientEmails.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNotificationRecipientEmails.json index bda08a043fff..2f3dec549f64 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNotificationRecipientEmails.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNotificationRecipientEmails.json @@ -1,43 +1,45 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "notificationName": "RequestPublisherNotificationMessage" + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", - "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", "name": "contoso@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", "properties": { "email": "contoso@live.com" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", - "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", "name": "foobar!live", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", "properties": { "email": "foobar!live" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", - "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", "name": "foobar@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", "properties": { "email": "foobar@live.com" } } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "NotificationRecipientEmail_ListByNotification", + "title": "ApiManagementListNotificationRecipientEmails" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNotificationRecipientUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNotificationRecipientUsers.json index 9973464c0787..4623137005c1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNotificationRecipientUsers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNotificationRecipientUsers.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "notificationName": "RequestPublisherNotificationMessage" + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", - "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", "name": "576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", "properties": { "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "NotificationRecipientUser_ListByNotification", + "title": "ApiManagementListNotificationRecipientUsers" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNotifications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNotifications.json index e4b3279b0b25..2e3ab53368d8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNotifications.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListNotifications.json @@ -1,20 +1,21 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 7, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", - "type": "Microsoft.ApiManagement/service/notifications", "name": "RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", "properties": { - "title": "Subscription requests (requiring approval)", "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", "recipients": { "emails": [ @@ -25,15 +26,15 @@ "users": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" ] - } + }, + "title": "Subscription requests (requiring approval)" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/PurchasePublisherNotificationMessage", - "type": "Microsoft.ApiManagement/service/notifications", "name": "PurchasePublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/PurchasePublisherNotificationMessage", "properties": { - "title": "New subscriptions", "description": "The following email recipients and users will receive email notifications about new API product subscriptions.", "recipients": { "emails": [ @@ -42,86 +43,87 @@ "users": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" ] - } + }, + "title": "New subscriptions" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewApplicationNotificationMessage", - "type": "Microsoft.ApiManagement/service/notifications", "name": "NewApplicationNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewApplicationNotificationMessage", "properties": { - "title": "Application gallery requests", "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.", "recipients": { "emails": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com" ], "users": [] - } + }, + "title": "Application gallery requests" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/BCC", - "type": "Microsoft.ApiManagement/service/notifications", "name": "BCC", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/BCC", "properties": { - "title": "BCC", "description": "The following recipients will receive blind carbon copies of all emails sent to developers.", "recipients": { "emails": [], "users": [] - } + }, + "title": "BCC" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewIssuePublisherNotificationMessage", - "type": "Microsoft.ApiManagement/service/notifications", "name": "NewIssuePublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewIssuePublisherNotificationMessage", "properties": { - "title": "New issue or comment", "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.", "recipients": { "emails": [], "users": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" ] - } + }, + "title": "New issue or comment" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/AccountClosedPublisher", - "type": "Microsoft.ApiManagement/service/notifications", "name": "AccountClosedPublisher", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/AccountClosedPublisher", "properties": { - "title": "Close account message", "description": "The following email recipients and users will receive email notifications when developer closes his account", "recipients": { "emails": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com" ], "users": [] - } + }, + "title": "Close account message" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/QuotaLimitApproachingPublisherNotificationMessage", - "type": "Microsoft.ApiManagement/service/notifications", "name": "QuotaLimitApproachingPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/QuotaLimitApproachingPublisherNotificationMessage", "properties": { - "title": "Approaching subscription quota limit", "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.", "recipients": { "emails": [], "users": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" ] - } + }, + "title": "Approaching subscription quota limit" } } - ], - "count": 7, - "nextLink": "" + ] } } - } + }, + "operationId": "Notification_ListByService", + "title": "ApiManagementListNotifications" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListOpenIdConnectProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListOpenIdConnectProviders.json index 5ce02f10ad19..36095571737e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListOpenIdConnectProviders.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListOpenIdConnectProviders.json @@ -1,31 +1,33 @@ { "parameters": { + "api-version": "2024-10-01-preview", "resourceGroupName": "rg1", "serviceName": "apimService1", - "api-version": "2024-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", - "type": "Microsoft.ApiManagement/service/openidconnectproviders", "name": "templateOpenIdConnect2", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", "properties": { - "displayName": "templateoidprovider2", "description": "open id provider template2", - "metadataEndpoint": "https://oidprovider-template2.net", "clientId": "oidprovidertemplate2", - "useInTestConsole": false, - "useInApiDocumentation": true + "displayName": "templateoidprovider2", + "metadataEndpoint": "https://oidprovider-template2.net", + "useInApiDocumentation": true, + "useInTestConsole": false } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "OpenIdConnectProvider_ListByService", + "title": "ApiManagementListOpenIdConnectProviders" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListOperations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListOperations.json index baec232df3c8..e0208fa0e91d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListOperations.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListOperations.json @@ -9,51 +9,53 @@ { "name": "Microsoft.ApiManagement/service/write", "display": { - "provider": "Microsoft API Management", - "resource": "Service", + "description": "Create a new instance of API Management Service", "operation": "Create a new instance of API Management Service", - "description": "Create a new instance of API Management Service" + "provider": "Microsoft API Management", + "resource": "Service" } }, { "name": "Microsoft.ApiManagement/service/read", "display": { - "provider": "Microsoft API Management", - "resource": "Service", + "description": "Read metadata for an API Management Service instance", "operation": "Read metadata for an API Management Service instance", - "description": "Read metadata for an API Management Service instance" + "provider": "Microsoft API Management", + "resource": "Service" } }, { "name": "Microsoft.ApiManagement/service/delete", "display": { - "provider": "Microsoft API Management", - "resource": "Service", + "description": "Delete API Management Service instance", "operation": "Delete API Management Service instance", - "description": "Delete API Management Service instance" + "provider": "Microsoft API Management", + "resource": "Service" } }, { - "origin": "system", "name": "Microsoft.ApiManagement/service/providers/Microsoft.Insights/diagnosticSettings/write", "display": { - "provider": "Microsoft API Management", - "resource": "Service", + "description": "Creates or updates the diagnostic setting for API Management service", "operation": "Write diagnostic setting", - "description": "Creates or updates the diagnostic setting for API Management service" - } + "provider": "Microsoft API Management", + "resource": "Service" + }, + "origin": "system" }, { "name": "Microsoft.ApiManagement/service/tenant/operationResults/read", "display": { - "provider": "Microsoft API Management", - "resource": "Results of async operations", + "description": "Get list of operation results or Get result of a specific operation", "operation": "Get operation results or Get operation result", - "description": "Get list of operation results or Get result of a specific operation" + "provider": "Microsoft API Management", + "resource": "Results of async operations" } } ] } } - } + }, + "operationId": "ApiManagementOperations_List", + "title": "ApiManagementListOperations" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicies.json index 0ee72e31db1f..460c37053f3a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicies.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicies.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", - "type": "Microsoft.ApiManagement/service/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", "properties": { "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "Policy_ListByService", + "title": "ApiManagementListPolicies" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyDescriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyDescriptions.json index abe43e2f5061..ac7dca8108d7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyDescriptions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyDescriptions.json @@ -1,36 +1,38 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "scope": "Api" + "resourceGroupName": "rg1", + "scope": "Api", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 2, "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-basic", - "type": "Microsoft.ApiManagement/service/policyDescriptions", "name": "authentication-basic", + "type": "Microsoft.ApiManagement/service/policyDescriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-basic", "properties": { "description": "Authenticate with the backend service using Basic authentication. Use in the inbound section at API scope.", "scope": 268435471 } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-certificate", - "type": "Microsoft.ApiManagement/service/policyDescriptions", "name": "authentication-certificate", + "type": "Microsoft.ApiManagement/service/policyDescriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-certificate", "properties": { "description": "Authenticate with the backend service using a client certificate. Use in the inbound section at API scope.", "scope": 268435471 } } - ], - "count": 2 + ] } } - } + }, + "operationId": "PolicyDescription_ListByService", + "title": "ApiManagementListPolicyDescriptions" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyFragmentReferences.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyFragmentReferences.json index 11fac97f7ea5..13d175613d36 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyFragmentReferences.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyFragmentReferences.json @@ -1,24 +1,26 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "id": "policyFragment1" + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "name": "policy", "type": "Microsoft.ApiManagement/service/policies", - "name": "policy" + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy" } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "PolicyFragment_ListReferences", + "title": "ApiManagementListPolicyFragmentReferences" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyFragments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyFragments.json index ccde8e2b3508..d32dc6115c60 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyFragments.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyFragments.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", - "type": "Microsoft.ApiManagement/service/policyFragments", "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1", "properties": { "format": "xml", "description": "A policy fragment example", "value": "" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "PolicyFragment_ListByService", + "title": "ApiManagementListPolicyFragments" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyRestrictions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyRestrictions.json index 18785878fc92..fdf503036a1d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyRestrictions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPolicyRestrictions.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", - "type": "Microsoft.ApiManagement/service/policyRestrictions", "name": "policyRestriction1", + "type": "Microsoft.ApiManagement/service/policyRestrictions", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", "properties": { - "scope": "Sample Path to the policy document.", - "requireBase": "true" + "requireBase": "true", + "scope": "Sample Path to the policy document." } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "PolicyRestriction_ListByService", + "title": "ApiManagementListPolicyRestrictions" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPortalConfig.json index 91194d39a9dd..b39883de50dc 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPortalConfig.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPortalConfig.json @@ -1,28 +1,33 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", - "type": "Microsoft.ApiManagement/service/portalconfigs", "name": "default", + "type": "Microsoft.ApiManagement/service/portalconfigs", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", "properties": { - "enableBasicAuth": true, - "signin": { - "require": false + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] }, - "signup": { - "termsOfService": { - "text": "I agree to the service terms and conditions.", - "requireConsent": false - } + "csp": { + "allowedSources": [ + "*.contoso.com" + ], + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ] }, "delegation": { "delegateRegistration": false, @@ -30,25 +35,22 @@ "delegationUrl": null, "validationKey": null }, - "csp": { - "mode": "reportOnly", - "reportUri": [ - "https://report.contoso.com" - ], - "allowedSources": [ - "*.contoso.com" - ] + "enableBasicAuth": true, + "signin": { + "require": false }, - "cors": { - "allowedOrigins": [ - "https://contoso.com" - ] + "signup": { + "termsOfService": { + "requireConsent": false, + "text": "I agree to the service terms and conditions." + } } } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "PortalConfig_ListByService", + "title": "ApiManagementListPortalConfig" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPortalRevisions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPortalRevisions.json index 4aadae4e5f26..393a4248c47a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPortalRevisions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPortalRevisions.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -10,33 +10,35 @@ "body": { "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112000000", - "type": "Microsoft.ApiManagement/service/portalRevisions", "name": "20201112000000", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112000000", "properties": { "description": "portal revision", - "statusDetails": null, - "status": "completed", - "isCurrent": false, "createdDateTime": "2020-11-12T22:10:09.673Z", + "isCurrent": false, + "status": "completed", + "statusDetails": null, "updatedDateTime": "2020-11-12T22:12:41.46Z" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010", - "type": "Microsoft.ApiManagement/service/portalRevisions", "name": "20201112101010", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010", "properties": { "description": "portal revision 1", - "statusDetails": null, - "status": "completed", - "isCurrent": true, "createdDateTime": "2020-11-12T22:51:36.47Z", + "isCurrent": true, + "status": "completed", + "statusDetails": null, "updatedDateTime": "2020-11-12T22:52:00.097Z" } } ] } } - } + }, + "operationId": "PortalRevision_ListByService", + "title": "ApiManagementListPortalRevisions" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPortalSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPortalSettings.json index 85145d872bb8..c21fa229ae60 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPortalSettings.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPortalSettings.json @@ -1,52 +1,54 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 3, "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation", - "type": "Microsoft.ApiManagement/service/portalsettings", "name": "delegation", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation", "properties": { + "enabled": false, "subscriptions": { "enabled": false }, "userRegistration": { "enabled": false - }, - "enabled": false + } } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin", - "type": "Microsoft.ApiManagement/service/portalsettings", "name": "signin", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin", "properties": { "enabled": false } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup", - "type": "Microsoft.ApiManagement/service/portalsettings", "name": "signup", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup", "properties": { "enabled": true, "termsOfService": { - "text": "Terms of service", + "consentRequired": false, "enabled": false, - "consentRequired": false + "text": "Terms of service" } } } - ], - "count": 3 + ] } } - } + }, + "operationId": "PortalSettings_ListByService", + "title": "ApiManagementListPortalSettings" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPrivateEndpointConnections.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPrivateEndpointConnections.json index 066807844708..1f80524f4114 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPrivateEndpointConnections.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPrivateEndpointConnections.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -10,39 +10,41 @@ "body": { "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName", - "type": "Microsoft.ApiManagement/service/privateEndpointConnections", "name": "privateEndpointProxyName", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName", "properties": { - "provisioningState": "Pending", "privateEndpoint": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName" }, "privateLinkServiceConnectionState": { - "status": "Pending", "description": "Please approve my request, thanks", - "actionsRequired": "None" - } + "actionsRequired": "None", + "status": "Pending" + }, + "provisioningState": "Pending" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName2", - "type": "Microsoft.ApiManagement/service/privateEndpointConnections", "name": "privateEndpointProxyName2", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName2", "properties": { - "provisioningState": "Pending", "privateEndpoint": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName2" }, "privateLinkServiceConnectionState": { - "status": "Pending", "description": "Please approve my request, thanks", - "actionsRequired": "None" - } + "actionsRequired": "None", + "status": "Pending" + }, + "provisioningState": "Pending" } } ] } } - } + }, + "operationId": "PrivateEndpointConnection_ListByService", + "title": "ApiManagementListPrivateEndpointConnections" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPrivateLinkGroupResources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPrivateLinkGroupResources.json index be2b9020cfca..f3f9589e8a6e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPrivateLinkGroupResources.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListPrivateLinkGroupResources.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -10,9 +10,9 @@ "body": { "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/Gateway", "name": "Gateway", "type": "Microsoft.ApiManagement/service/privateLinkResources", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/Gateway", "properties": { "groupId": "Gateway", "requiredMembers": [ @@ -26,5 +26,7 @@ ] } } - } + }, + "operationId": "PrivateEndpointConnection_ListPrivateLinkResources", + "title": "ApiManagementListPrivateLinkGroupResources" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductApiLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductApiLinks.json index 12cab5a8e845..7d77e258fe8d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductApiLinks.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductApiLinks.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "product1" + "productId": "product1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/products/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ProductApiLink_ListByProduct", + "title": "ApiManagementListProductApiLinks" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductApis.json index fd6f9020e7ad..c67e88761580 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductApis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductApis.json @@ -1,35 +1,37 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "5768181ea40f7eb6c49f6ac7" + "productId": "5768181ea40f7eb6c49f6ac7", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7/apis/57681820a40f7eb6c49f6aca", - "type": "Microsoft.ApiManagement/service/products/apis", "name": "57681820a40f7eb6c49f6aca", + "type": "Microsoft.ApiManagement/service/products/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7/apis/57681820a40f7eb6c49f6aca", "properties": { - "displayName": "api_57681820a40f7eb6c49f6acb", - "apiRevision": "1", - "description": "description_57681820a40f7eb6c49f6acc", - "serviceUrl": "http://contoso/57681820a40f7eb6c49f6acd", "path": "suffix_57681820a40f7eb6c49f6ace", + "description": "description_57681820a40f7eb6c49f6acc", + "apiRevision": "1", + "displayName": "api_57681820a40f7eb6c49f6acb", + "isCurrent": true, "protocols": [ "https" ], - "isCurrent": true + "serviceUrl": "http://contoso/57681820a40f7eb6c49f6acd" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ProductApi_ListByProduct", + "title": "ApiManagementListProductApis" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductGroupLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductGroupLinks.json index 385737f284b9..fcfb6dfc9077 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductGroupLinks.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductGroupLinks.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "product1" + "productId": "product1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1/groupLinks/link1", - "type": "Microsoft.ApiManagement/service/products/groupLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/products/groupLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1/groupLinks/link1", "properties": { "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ProductGroupLink_ListByProduct", + "title": "ApiManagementListProductGroupLinks" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductGroups.json index 61d30f205aa3..136cc0803238 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductGroups.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductGroups.json @@ -1,52 +1,54 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "5600b57e7e8880006a060002" + "productId": "5600b57e7e8880006a060002", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020001", - "type": "Microsoft.ApiManagement/service/products/groups", "name": "5600b57e7e8880006a020001", + "type": "Microsoft.ApiManagement/service/products/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020001", "properties": { - "displayName": "Administrators", + "type": "system", "description": "Administrators is a built-in group. Its membership is managed by the system. Microsoft Azure subscription administrators fall into this group.", "builtIn": true, - "type": "system" + "displayName": "Administrators" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020002", - "type": "Microsoft.ApiManagement/service/products/groups", "name": "5600b57e7e8880006a020002", + "type": "Microsoft.ApiManagement/service/products/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020002", "properties": { - "displayName": "Developers", + "type": "system", "description": "Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.", "builtIn": true, - "type": "system" + "displayName": "Developers" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020003", - "type": "Microsoft.ApiManagement/service/products/groups", "name": "5600b57e7e8880006a020003", + "type": "Microsoft.ApiManagement/service/products/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020003", "properties": { - "displayName": "Guests", + "type": "system", "description": "Guests is a built-in group. Its membership is managed by the system. Unauthenticated users visiting the developer portal fall into this group.", "builtIn": true, - "type": "system" + "displayName": "Guests" } } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "ProductGroup_ListByProduct", + "title": "ApiManagementListProductGroups" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductPolicies.json index 77b6b75beeab..f896f3409e39 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductPolicies.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductPolicies.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "armTemplateProduct4" + "productId": "armTemplateProduct4", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/armTemplateProduct4/policies/policy", - "type": "Microsoft.ApiManagement/service/products/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/armTemplateProduct4/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ProductPolicy_ListByProduct", + "title": "ApiManagementListProductPolicies" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductSubscriptions.json index 2638f8bc6a7e..8ca8d063af35 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductSubscriptions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductSubscriptions.json @@ -1,30 +1,32 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "5600b57e7e8880006a060002" + "productId": "5600b57e7e8880006a060002", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/subscriptions/5600b57e7e8880006a070002", - "type": "Microsoft.ApiManagement/service/products/subscriptions", "name": "5600b57e7e8880006a070002", + "type": "Microsoft.ApiManagement/service/products/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/subscriptions/5600b57e7e8880006a070002", "properties": { + "createdDate": "2015-09-22T01:57:18.723Z", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002", - "state": "active", - "createdDate": "2015-09-22T01:57:18.723Z" + "state": "active" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "ProductSubscriptions_List", + "title": "ApiManagementListProductSubscriptions" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductTags.json index 157cc8efbdb4..638daad8ce5c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductTags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductTags.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "57d2ef278aa04f0888cba3f1" + "productId": "57d2ef278aa04f0888cba3f1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", - "type": "Microsoft.ApiManagement/service/tags", "name": "5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", "properties": { "displayName": "tag1" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "Tag_ListByProduct", + "title": "ApiManagementListProductTags" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductWikis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductWikis.json index 514d466b4faf..fd652be3ecda 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductWikis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductWikis.json @@ -1,19 +1,20 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "57d1f7558aa04f15146d9d8a" + "productId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", - "type": "Microsoft.ApiManagement/service/products/wikis", "name": "default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", "properties": { "documents": [ { @@ -25,9 +26,10 @@ ] } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "ProductWikis_list", + "title": "ApiManagementGetApiWiki" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProducts.json index f30ed2ad33a4..a053dd96e86b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProducts.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProducts.json @@ -1,56 +1,58 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmtemplateCert1", - "type": "Microsoft.ApiManagement/service/products", "name": "kjoshiarmtemplateCert1", + "type": "Microsoft.ApiManagement/service/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmtemplateCert1", "properties": { - "displayName": "Dev", "description": "Development Product", - "subscriptionRequired": false, - "state": "published" + "displayName": "Dev", + "state": "published", + "subscriptionRequired": false } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter", - "type": "Microsoft.ApiManagement/service/products", "name": "starter", + "type": "Microsoft.ApiManagement/service/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter", "properties": { - "displayName": "Starter", "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", - "terms": "", - "subscriptionRequired": true, "approvalRequired": false, + "displayName": "Starter", + "state": "published", + "subscriptionRequired": true, "subscriptionsLimit": 1, - "state": "published" + "terms": "" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited", - "type": "Microsoft.ApiManagement/service/products", "name": "unlimited", + "type": "Microsoft.ApiManagement/service/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited", "properties": { - "displayName": "Unlimited", "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", - "subscriptionRequired": true, "approvalRequired": true, - "subscriptionsLimit": 1, - "state": "published" + "displayName": "Unlimited", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1 } } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "Product_ListByService", + "title": "ApiManagementListProducts" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductsByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductsByTags.json index 8943dd57668c..3166e162688d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductsByTags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListProductsByTags.json @@ -1,33 +1,35 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, "value": [ { - "tag": { - "id": "/tags/apitag123", - "name": "awesomeTag" - }, "product": { - "id": "/products/starter", "name": "Starter", "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", - "terms": "", - "subscriptionRequired": true, "approvalRequired": false, + "id": "/products/starter", + "state": "published", + "subscriptionRequired": true, "subscriptionsLimit": 1, - "state": "published" + "terms": "" + }, + "tag": { + "name": "awesomeTag", + "id": "/tags/apitag123" } } - ], - "count": 1 + ] } } - } + }, + "operationId": "Product_ListByTags", + "title": "ApiManagementListProductsByTags" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListRegions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListRegions.json index e13cea85418c..9deeaf3d55c8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListRegions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListRegions.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { "name": "West US", - "isMasterRegion": true, - "isDeleted": false + "isDeleted": false, + "isMasterRegion": true } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "Region_ListByService", + "title": "ApiManagementListRegions" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSKUs-Consumption.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSKUs-Consumption.json index b0cd8f66b725..adcbaf428de9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSKUs-Consumption.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSKUs-Consumption.json @@ -1,24 +1,26 @@ { "parameters": { "api-version": "2024-10-01-preview", - "serviceName": "apimService1", "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": null, "value": [ { + "capacity": null, "resourceType": "Microsoft.ApiManagement/service", "sku": { "name": "Consumption" - }, - "capacity": null + } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "ApiManagementServiceSkus_ListAvailableServiceSkus", + "title": "ApiManagementListSKUs-Consumption" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSKUs-Dedicated.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSKUs-Dedicated.json index 218149b402d2..a1870b7d8dbd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSKUs-Dedicated.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSKUs-Dedicated.json @@ -1,77 +1,79 @@ { "parameters": { "api-version": "2024-10-01-preview", - "serviceName": "apimService1", "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": null, "value": [ { - "resourceType": "Microsoft.ApiManagement/service", - "sku": { - "name": "Developer" - }, "capacity": { - "minimum": 1, - "maximum": 1, "default": 1, + "maximum": 1, + "minimum": 1, "scaleType": "none" + }, + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Developer" } }, { - "resourceType": "Microsoft.ApiManagement/service", - "sku": { - "name": "Basic" - }, "capacity": { - "minimum": 1, - "maximum": 2, "default": 1, + "maximum": 2, + "minimum": 1, "scaleType": "manual" + }, + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Basic" } }, { - "resourceType": "Microsoft.ApiManagement/service", - "sku": { - "name": "Standard" - }, "capacity": { - "minimum": 1, - "maximum": 4, "default": 1, + "maximum": 4, + "minimum": 1, "scaleType": "automatic" + }, + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Standard" } }, { - "resourceType": "Microsoft.ApiManagement/service", - "sku": { - "name": "Premium" - }, "capacity": { - "minimum": 1, - "maximum": 10, "default": 1, + "maximum": 10, + "minimum": 1, "scaleType": "automatic" + }, + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Premium" } }, { - "resourceType": "Microsoft.ApiManagement/service", - "sku": { - "name": "Isolated" - }, "capacity": { - "minimum": 1, - "maximum": 1, "default": 1, + "maximum": 1, + "minimum": 1, "scaleType": "automatic" + }, + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Isolated" } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "ApiManagementServiceSkus_ListAvailableServiceSkus", + "title": "ApiManagementListSKUs-Dedicated" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSKUs-Gateways.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSKUs-Gateways.json index ad0d0655c982..18ac2e0f7c7b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSKUs-Gateways.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSKUs-Gateways.json @@ -8,34 +8,36 @@ "responses": { "200": { "body": { + "nextLink": null, "value": [ { - "resourceType": "Microsoft.ApiManagement/gateways", - "sku": { - "name": "WorkspaceGatewayStandard" - }, "capacity": { - "minimum": 1, - "maximum": 4, "default": 1, + "maximum": 4, + "minimum": 1, "scaleType": "Manual" + }, + "resourceType": "Microsoft.ApiManagement/gateways", + "sku": { + "name": "WorkspaceGatewayStandard" } }, { - "resourceType": "Microsoft.ApiManagement/gateways", - "sku": { - "name": "WorkspaceGatewayPremium" - }, "capacity": { - "minimum": 1, - "maximum": 12, "default": 1, + "maximum": 12, + "minimum": 1, "scaleType": "Manual" + }, + "resourceType": "Microsoft.ApiManagement/gateways", + "sku": { + "name": "WorkspaceGatewayPremium" } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "ApiManagementGatewaySkus_ListAvailableSkus", + "title": "ApiManagementListSKUs-Gateways" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSecretsPortalSettingsValidationKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSecretsPortalSettingsValidationKey.json index 45301ee8dc48..6696a8f1b068 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSecretsPortalSettingsValidationKey.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSecretsPortalSettingsValidationKey.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -11,5 +11,7 @@ "validationKey": "" } } - } + }, + "operationId": "DelegationSettings_ListSecrets", + "title": "ApiManagementListSecretsPortalSettings" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSecretsTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSecretsTenantAccess.json index 1cd2f89ff311..a862730ea7df 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSecretsTenantAccess.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSecretsTenantAccess.json @@ -1,19 +1,21 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "accessName": "access", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "accessName": "access" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "enabled": true, "id": "5600b59375ff190048030003", "primaryKey": "", - "secondaryKey": "", - "enabled": true + "secondaryKey": "" } } - } + }, + "operationId": "TenantAccess_ListSecrets", + "title": "ApiManagementListSecretsTenantAccess" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListServiceBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListServiceBySubscription.json index 353ffb759020..0adbc141d2be 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListServiceBySubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListServiceBySubscription.json @@ -8,370 +8,372 @@ "body": { "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium", "name": "OGF-Z3-06162021-Premium", "type": "Microsoft.ApiManagement/service", - "tags": { - "owner": "v-aswmoh", - "ReleaseName": "Z3" + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789", + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d" + } + } }, "location": "East US", - "etag": "AAAAAAAWN/4=", "properties": { - "publisherEmail": "bar@contoso.com", - "publisherName": "Test Premium", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", + "additionalLocations": [ + { + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net", + "location": "East US 2", + "publicIPAddresses": [ + "40.70.24.106" + ], + "sku": { + "name": "Premium", + "capacity": 1 + }, + "zones": [] + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "certificates": [], + "configurationApi": { + "legacyApi": "Enabled" + }, "createdAtUtc": "2021-06-16T09:40:00.9453556Z", - "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net", - "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net", - "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false" + }, "developerPortalUrl": "https://ogf-z3-06162021-premium.developer.azure-api.net", - "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net", - "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "ogf-z3-06162021-premium.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": false, - "certificateSource": "BuiltIn" + "hostName": "ogf-z3-06162021-premium.azure-api.net", + "negotiateClientCertificate": false }, { "type": "Proxy", - "hostName": "gateway.current.int-azure-api.net", - "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", - "negotiateClientCertificate": true, "certificate": { "expiry": "2022-01-08T22:32:32+00:00", - "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", - "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" }, + "certificateSource": "Custom", "defaultSslBinding": true, - "certificateSource": "Custom" + "hostName": "gateway.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": true }, { "type": "DeveloperPortal", - "hostName": "developer.current.int-azure-api.net", - "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", - "negotiateClientCertificate": false, "certificate": { "expiry": "2022-01-08T22:32:32+00:00", - "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", - "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" }, + "certificateSource": "Custom", "defaultSslBinding": false, - "certificateSource": "Custom" + "hostName": "developer.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false }, { "type": "Management", - "hostName": "mgmt.current.int-azure-api.net", - "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", - "negotiateClientCertificate": false, "certificate": { "expiry": "2022-01-08T22:32:32+00:00", - "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", - "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" }, + "certificateSource": "Custom", "defaultSslBinding": false, - "certificateSource": "Custom" + "hostName": "mgmt.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false }, { "type": "ConfigurationApi", - "hostName": "configuration-api.current.int-azure-api.net", - "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", - "negotiateClientCertificate": false, "certificate": { "expiry": "2022-01-08T22:32:32+00:00", - "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", - "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" }, + "certificateSource": "Custom", "defaultSslBinding": false, - "certificateSource": "Custom" + "hostName": "configuration-api.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false } ], + "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net", + "provisioningState": "Succeeded", "publicIPAddresses": [ "13.92.130.49" ], - "additionalLocations": [ - { - "location": "East US 2", - "sku": { - "name": "Premium", - "capacity": 1 - }, - "zones": [], - "publicIPAddresses": [ - "40.70.24.106" - ], - "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net", - "disableGateway": false - } - ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false" - }, - "virtualNetworkType": "None", - "certificates": [], - "disableGateway": false, - "apiVersionConstraint": { - "minApiVersion": "2019-12-01" - }, - "configurationApi": { - "legacyApi": "Enabled" - }, - "publicNetworkAccess": "Enabled" + "publicNetworkAccess": "Enabled", + "publisherEmail": "bar@contoso.com", + "publisherName": "Test Premium", + "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 }, - "identity": { - "type": "SystemAssigned, UserAssigned", - "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e", - "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", - "userAssignedIdentities": { - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { - "principalId": "713784d2-ee37-412a-95f0-3768f397f82d", - "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789" - } - } - }, "systemData": { + "createdAt": "2021-06-16T09:40:00.7106733Z", "createdBy": "bar@contoso.com", "createdByType": "User", - "createdAt": "2021-06-16T09:40:00.7106733Z", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z", "lastModifiedBy": "foo@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-06-20T06:33:09.6159006Z" + "lastModifiedByType": "User" + }, + "tags": { + "ReleaseName": "Z3", + "owner": "v-aswmoh" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/vvktestcons", "name": "vvktestcons", "type": "Microsoft.ApiManagement/service", - "tags": { - "Owner": "vitaliik" - }, - "location": "East US", "etag": "AAAAAAAWKwo=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/vvktestcons", + "location": "East US", "properties": { - "publisherEmail": "bar@contoso.com", - "publisherName": "vvktestcons", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", "createdAtUtc": "2020-08-10T18:07:23.4565211Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "disableGateway": false, + "enableClientCertificate": false, "gatewayUrl": "https://vvktestcons.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "vvktestcons.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "vvktestcons.azure-api.net", + "negotiateClientCertificate": false } ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "enableClientCertificate": false, - "disableGateway": false, - "publicNetworkAccess": "Enabled" + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "publisherEmail": "bar@contoso.com", + "publisherName": "vvktestcons", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Consumption", "capacity": 0 + }, + "tags": { + "Owner": "vitaliik" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Standard", "name": "OGF-Z3-06162021-Standard", "type": "Microsoft.ApiManagement/service", - "tags": {}, - "location": "East US", "etag": "AAAAAAAWF7M=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Standard", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "347a5800-ca99-475a-9202-fe38ca79ee41", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789", + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d" + } + } + }, + "location": "East US", "properties": { - "publisherEmail": "bar@contoso.com", - "publisherName": "Test Standard", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "configurationApi": { + "legacyApi": "Enabled" + }, "createdAtUtc": "2021-06-16T09:39:58.6555759Z", - "gatewayUrl": "https://ogf-z3-06162021-standard.azure-api.net", - "gatewayRegionalUrl": "https://ogf-z3-06162021-standard-eastus-01.regional.azure-api.net", - "portalUrl": "https://ogf-z3-06162021-standard.portal.azure-api.net", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA": "true", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, "developerPortalUrl": "https://ogf-z3-06162021-standard.developer.azure-api.net", - "managementApiUrl": "https://ogf-z3-06162021-standard.management.azure-api.net", - "scmUrl": "https://ogf-z3-06162021-standard.scm.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-standard-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://ogf-z3-06162021-standard.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "ogf-z3-06162021-standard.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "ogf-z3-06162021-standard.azure-api.net", + "negotiateClientCertificate": false } ], + "managementApiUrl": "https://ogf-z3-06162021-standard.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://ogf-z3-06162021-standard.portal.azure-api.net", + "provisioningState": "Succeeded", "publicIPAddresses": [ "13.82.208.32" ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA": "true", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, - "apiVersionConstraint": { - "minApiVersion": "2019-12-01" - }, - "configurationApi": { - "legacyApi": "Enabled" - }, - "publicNetworkAccess": "Enabled" + "publicNetworkAccess": "Enabled", + "publisherEmail": "bar@contoso.com", + "publisherName": "Test Standard", + "scmUrl": "https://ogf-z3-06162021-standard.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Standard", "capacity": 2 }, - "identity": { - "type": "SystemAssigned, UserAssigned", - "principalId": "347a5800-ca99-475a-9202-fe38ca79ee41", - "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", - "userAssignedIdentities": { - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { - "principalId": "713784d2-ee37-412a-95f0-3768f397f82d", - "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789" - } - } - }, "systemData": { + "createdAt": "2021-06-16T09:39:58.4591834Z", "createdBy": "bar@contoso.com", "createdByType": "User", - "createdAt": "2021-06-16T09:39:58.4591834Z", + "lastModifiedAt": "2021-06-17T15:05:13.5494721Z", "lastModifiedBy": "bar@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-06-17T15:05:13.5494721Z" - } + "lastModifiedByType": "User" + }, + "tags": {} }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/ogf-dev-060921", "name": "ogf-dev-060921", "type": "Microsoft.ApiManagement/service", - "tags": {}, - "location": "East US", "etag": "AAAAAAAWEFg=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/ogf-dev-060921", + "identity": { + "type": "SystemAssigned", + "principalId": "c9bd4c05-205e-4431-b232-112cf2e9e0aa", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + }, + "location": "East US", "properties": { - "publisherEmail": "v-ssaiprasan@microsoft.com", - "publisherName": "TechM", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2021-06-09T10:06:22.2133978Z", - "gatewayUrl": "https://ogf-dev-060921.azure-api.net", - "gatewayRegionalUrl": "https://ogf-dev-060921-eastus-01.regional.azure-api.net", - "portalUrl": "https://ogf-dev-060921.portal.azure-api.net", - "developerPortalUrl": "https://ogf-dev-060921.developer.azure-api.net", - "managementApiUrl": "https://ogf-dev-060921.management.azure-api.net", - "scmUrl": "https://ogf-dev-060921.scm.azure-api.net", - "hostnameConfigurations": [ - { - "type": "Proxy", - "hostName": "ogf-dev-060921.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": true, - "certificateSource": "BuiltIn" - } - ], - "publicIPAddresses": [ - "168.62.39.172" - ], "additionalLocations": [ { + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-dev-060921-southcentralus-01.regional.azure-api.net", "location": "South Central US", + "publicIPAddresses": [ + "13.84.208.29" + ], "sku": { "name": "Premium", "capacity": 9 }, - "zones": [], - "publicIPAddresses": [ - "13.84.208.29" - ], - "gatewayRegionalUrl": "https://ogf-dev-060921-southcentralus-01.regional.azure-api.net", - "disableGateway": false + "zones": [] } ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false" + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" }, - "virtualNetworkType": "None", "certificates": [ { - "storeName": "Root", "certificate": { "expiry": "2021-11-25T22:51:47+00:00", - "thumbprint": "4E8234312EC69245D1AE296C4882D46FB84076A3", - "subject": "CN=*.apim.net" - } + "subject": "CN=*.apim.net", + "thumbprint": "4E8234312EC69245D1AE296C4882D46FB84076A3" + }, + "storeName": "Root" } ], - "disableGateway": false, - "apiVersionConstraint": { - "minApiVersion": "2019-12-01" - }, "configurationApi": { "legacyApi": "Enabled" }, - "publicNetworkAccess": "Enabled" + "createdAtUtc": "2021-06-09T10:06:22.2133978Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false" + }, + "developerPortalUrl": "https://ogf-dev-060921.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-dev-060921-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://ogf-dev-060921.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "ogf-dev-060921.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://ogf-dev-060921.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://ogf-dev-060921.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "168.62.39.172" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "v-ssaiprasan@microsoft.com", + "publisherName": "TechM", + "scmUrl": "https://ogf-dev-060921.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 3 }, - "identity": { - "type": "SystemAssigned", - "principalId": "c9bd4c05-205e-4431-b232-112cf2e9e0aa", - "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" - }, "systemData": { + "createdAt": "2021-06-09T10:06:21.7336597Z", "createdBy": "v-ssaiprasan@microsoft.com", "createdByType": "User", - "createdAt": "2021-06-09T10:06:21.7336597Z", + "lastModifiedAt": "2021-06-10T14:27:05.546816Z", "lastModifiedBy": "v-ssaiprasan@microsoft.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-06-10T14:27:05.546816Z" - } + "lastModifiedByType": "User" + }, + "tags": {} } ] } } - } + }, + "operationId": "ApiManagementService_List", + "title": "ApiManagementListServiceBySubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json index d6c060f2c136..cc56d2613238 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json @@ -1,7 +1,7 @@ { "parameters": { - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -9,361 +9,363 @@ "body": { "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium", "name": "OGF-Z3-06162021-Premium", "type": "Microsoft.ApiManagement/service", - "tags": { - "owner": "v-aswmoh", - "ReleaseName": "Z3" + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789", + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d" + } + } }, "location": "East US", - "etag": "AAAAAAAWN/4=", "properties": { - "publisherEmail": "bar@contoso.com", - "publisherName": "Test Premium", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", + "additionalLocations": [ + { + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net", + "location": "East US 2", + "publicIPAddresses": [ + "40.70.24.106" + ], + "sku": { + "name": "Premium", + "capacity": 1 + }, + "zones": [] + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "certificates": [], "createdAtUtc": "2021-06-16T09:40:00.9453556Z", - "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net", - "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net", - "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false" + }, "developerPortalUrl": "https://ogf-z3-06162021-premium.developer.azure-api.net", - "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net", - "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "ogf-z3-06162021-premium.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": false, - "certificateSource": "BuiltIn" + "hostName": "ogf-z3-06162021-premium.azure-api.net", + "negotiateClientCertificate": false }, { "type": "Proxy", - "hostName": "gateway.current.int-azure-api.net", - "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", - "negotiateClientCertificate": true, "certificate": { "expiry": "2022-01-08T22:32:32+00:00", - "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", - "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" }, + "certificateSource": "Custom", "defaultSslBinding": true, - "certificateSource": "Custom" + "hostName": "gateway.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": true }, { "type": "DeveloperPortal", - "hostName": "developer.current.int-azure-api.net", - "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", - "negotiateClientCertificate": false, "certificate": { "expiry": "2022-01-08T22:32:32+00:00", - "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", - "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" }, + "certificateSource": "Custom", "defaultSslBinding": false, - "certificateSource": "Custom" + "hostName": "developer.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false }, { "type": "Management", - "hostName": "mgmt.current.int-azure-api.net", - "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", - "negotiateClientCertificate": false, "certificate": { "expiry": "2022-01-08T22:32:32+00:00", - "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", - "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" }, + "certificateSource": "Custom", "defaultSslBinding": false, - "certificateSource": "Custom" + "hostName": "mgmt.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false }, { "type": "ConfigurationApi", - "hostName": "configuration-api.current.int-azure-api.net", - "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", - "negotiateClientCertificate": false, "certificate": { "expiry": "2022-01-08T22:32:32+00:00", - "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51", - "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286F71AF3B6A01BDB240C58A4A507E3DBD51" }, + "certificateSource": "Custom", "defaultSslBinding": false, - "certificateSource": "Custom" + "hostName": "configuration-api.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault-int.azure-int.net/secrets/current-ssl", + "negotiateClientCertificate": false } ], + "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net", + "provisioningState": "Succeeded", "publicIPAddresses": [ "13.92.130.49" ], - "additionalLocations": [ - { - "location": "East US 2", - "sku": { - "name": "Premium", - "capacity": 1 - }, - "zones": [], - "publicIPAddresses": [ - "40.70.24.106" - ], - "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net", - "disableGateway": false - } - ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false" - }, - "virtualNetworkType": "None", - "certificates": [], - "disableGateway": false, - "apiVersionConstraint": { - "minApiVersion": "2019-12-01" - }, - "publicNetworkAccess": "Enabled" + "publicNetworkAccess": "Enabled", + "publisherEmail": "bar@contoso.com", + "publisherName": "Test Premium", + "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 }, - "identity": { - "type": "SystemAssigned, UserAssigned", - "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e", - "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", - "userAssignedIdentities": { - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { - "principalId": "713784d2-ee37-412a-95f0-3768f397f82d", - "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789" - } - } - }, "systemData": { + "createdAt": "2021-06-16T09:40:00.7106733Z", "createdBy": "bar@contoso.com", "createdByType": "User", - "createdAt": "2021-06-16T09:40:00.7106733Z", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z", "lastModifiedBy": "foo@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-06-20T06:33:09.6159006Z" + "lastModifiedByType": "User" + }, + "tags": { + "ReleaseName": "Z3", + "owner": "v-aswmoh" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/vvktestcons", "name": "vvktestcons", "type": "Microsoft.ApiManagement/service", - "tags": { - "Owner": "vitaliik" - }, - "location": "East US", "etag": "AAAAAAAWKwo=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/vvktestcons", + "location": "East US", "properties": { - "publisherEmail": "bar@contoso.com", - "publisherName": "vvktestcons", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", "createdAtUtc": "2020-08-10T18:07:23.4565211Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "disableGateway": false, + "enableClientCertificate": false, "gatewayUrl": "https://vvktestcons.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "vvktestcons.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "vvktestcons.azure-api.net", + "negotiateClientCertificate": false } ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "enableClientCertificate": false, - "disableGateway": false, - "publicNetworkAccess": "Enabled" + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "publisherEmail": "bar@contoso.com", + "publisherName": "vvktestcons", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Consumption", "capacity": 0 + }, + "tags": { + "Owner": "vitaliik" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Standard", "name": "OGF-Z3-06162021-Standard", "type": "Microsoft.ApiManagement/service", - "tags": {}, - "location": "East US", "etag": "AAAAAAAWF7M=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Standard", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "347a5800-ca99-475a-9202-fe38ca79ee41", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789", + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d" + } + } + }, + "location": "East US", "properties": { - "publisherEmail": "bar@contoso.com", - "publisherName": "Test Standard", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, "createdAtUtc": "2021-06-16T09:39:58.6555759Z", - "gatewayUrl": "https://ogf-z3-06162021-standard.azure-api.net", - "gatewayRegionalUrl": "https://ogf-z3-06162021-standard-eastus-01.regional.azure-api.net", - "portalUrl": "https://ogf-z3-06162021-standard.portal.azure-api.net", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA": "true", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, "developerPortalUrl": "https://ogf-z3-06162021-standard.developer.azure-api.net", - "managementApiUrl": "https://ogf-z3-06162021-standard.management.azure-api.net", - "scmUrl": "https://ogf-z3-06162021-standard.scm.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-standard-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://ogf-z3-06162021-standard.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "ogf-z3-06162021-standard.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": true, - "certificateSource": "BuiltIn" + "hostName": "ogf-z3-06162021-standard.azure-api.net", + "negotiateClientCertificate": false } ], + "managementApiUrl": "https://ogf-z3-06162021-standard.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://ogf-z3-06162021-standard.portal.azure-api.net", + "provisioningState": "Succeeded", "publicIPAddresses": [ "13.82.208.32" ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA": "true", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, - "apiVersionConstraint": { - "minApiVersion": "2019-12-01" - }, - "publicNetworkAccess": "Enabled" + "publicNetworkAccess": "Enabled", + "publisherEmail": "bar@contoso.com", + "publisherName": "Test Standard", + "scmUrl": "https://ogf-z3-06162021-standard.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Standard", "capacity": 2 }, - "identity": { - "type": "SystemAssigned, UserAssigned", - "principalId": "347a5800-ca99-475a-9202-fe38ca79ee41", - "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", - "userAssignedIdentities": { - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { - "principalId": "713784d2-ee37-412a-95f0-3768f397f82d", - "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789" - } - } - }, "systemData": { + "createdAt": "2021-06-16T09:39:58.4591834Z", "createdBy": "bar@contoso.com", "createdByType": "User", - "createdAt": "2021-06-16T09:39:58.4591834Z", + "lastModifiedAt": "2021-06-17T15:05:13.5494721Z", "lastModifiedBy": "bar@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-06-17T15:05:13.5494721Z" - } + "lastModifiedByType": "User" + }, + "tags": {} }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/ogf-dev-060921", "name": "ogf-dev-060921", "type": "Microsoft.ApiManagement/service", - "tags": {}, - "location": "East US", "etag": "AAAAAAAWEFg=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/ogf-dev-060921", + "identity": { + "type": "SystemAssigned", + "principalId": "c9bd4c05-205e-4431-b232-112cf2e9e0aa", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + }, + "location": "East US", "properties": { - "publisherEmail": "v-ssaiprasan@microsoft.com", - "publisherName": "TechM", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2021-06-09T10:06:22.2133978Z", - "gatewayUrl": "https://ogf-dev-060921.azure-api.net", - "gatewayRegionalUrl": "https://ogf-dev-060921-eastus-01.regional.azure-api.net", - "portalUrl": "https://ogf-dev-060921.portal.azure-api.net", - "developerPortalUrl": "https://ogf-dev-060921.developer.azure-api.net", - "managementApiUrl": "https://ogf-dev-060921.management.azure-api.net", - "scmUrl": "https://ogf-dev-060921.scm.azure-api.net", - "hostnameConfigurations": [ - { - "type": "Proxy", - "hostName": "ogf-dev-060921.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": true, - "certificateSource": "BuiltIn" - } - ], - "publicIPAddresses": [ - "168.62.39.172" - ], "additionalLocations": [ { + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-dev-060921-southcentralus-01.regional.azure-api.net", "location": "South Central US", + "publicIPAddresses": [ + "13.84.208.29" + ], "sku": { "name": "Premium", "capacity": 9 }, - "zones": [], - "publicIPAddresses": [ - "13.84.208.29" - ], - "gatewayRegionalUrl": "https://ogf-dev-060921-southcentralus-01.regional.azure-api.net", - "disableGateway": false + "zones": [] } ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false" + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" }, - "virtualNetworkType": "None", "certificates": [ { - "storeName": "Root", "certificate": { "expiry": "2021-11-25T22:51:47+00:00", - "thumbprint": "4E8234312EC69245D1AE296C4882D46FB84076A3", - "subject": "CN=*.apim.net" - } + "subject": "CN=*.apim.net", + "thumbprint": "4E8234312EC69245D1AE296C4882D46FB84076A3" + }, + "storeName": "Root" } ], - "disableGateway": false, - "apiVersionConstraint": { - "minApiVersion": "2019-12-01" + "createdAtUtc": "2021-06-09T10:06:22.2133978Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false" }, - "publicNetworkAccess": "Enabled" + "developerPortalUrl": "https://ogf-dev-060921.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-dev-060921-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://ogf-dev-060921.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": true, + "hostName": "ogf-dev-060921.azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://ogf-dev-060921.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://ogf-dev-060921.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "168.62.39.172" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "v-ssaiprasan@microsoft.com", + "publisherName": "TechM", + "scmUrl": "https://ogf-dev-060921.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 3 }, - "identity": { - "type": "SystemAssigned", - "principalId": "c9bd4c05-205e-4431-b232-112cf2e9e0aa", - "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" - }, "systemData": { + "createdAt": "2021-06-09T10:06:21.7336597Z", "createdBy": "v-ssaiprasan@microsoft.com", "createdByType": "User", - "createdAt": "2021-06-09T10:06:21.7336597Z", + "lastModifiedAt": "2021-06-10T14:27:05.546816Z", "lastModifiedBy": "v-ssaiprasan@microsoft.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-06-10T14:27:05.546816Z" - } + "lastModifiedByType": "User" + }, + "tags": {} } ] } } - } + }, + "operationId": "ApiManagementService_ListByResourceGroup", + "title": "ApiManagementListServiceBySubscriptionAndResourceGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSku.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSku.json index 672682e520a7..15040a132096 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSku.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSku.json @@ -8,217 +8,219 @@ "body": { "value": [ { - "resourceType": "service", "name": "Developer", - "locations": [ - "centralindia" - ], + "capacity": { + "default": 1, + "maximum": 1, + "minimum": 1, + "scaleType": "None" + }, "locationInfo": [ { "location": "centralindia", - "zones": [], - "zoneDetails": [] + "zoneDetails": [], + "zones": [] } ], - "capacity": { - "minimum": 1, - "maximum": 1, - "default": 1, - "scaleType": "None" - }, + "locations": [ + "centralindia" + ], + "resourceType": "service", "restrictions": [] }, { - "resourceType": "service", "name": "Standard", - "locations": [ - "centralindia" - ], + "capacity": { + "default": 1, + "maximum": 4, + "minimum": 1, + "scaleType": "Automatic" + }, "locationInfo": [ { "location": "centralindia", - "zones": [], - "zoneDetails": [] + "zoneDetails": [], + "zones": [] } ], - "capacity": { - "minimum": 1, - "maximum": 4, - "default": 1, - "scaleType": "Automatic" - }, + "locations": [ + "centralindia" + ], + "resourceType": "service", "restrictions": [] }, { - "resourceType": "service", "name": "Premium", - "locations": [ - "centralindia" - ], + "capacity": { + "default": 1, + "maximum": 10, + "minimum": 1, + "scaleType": "Automatic" + }, "locationInfo": [ { "location": "centralindia", - "zones": [], - "zoneDetails": [] + "zoneDetails": [], + "zones": [] } ], - "capacity": { - "minimum": 1, - "maximum": 10, - "default": 1, - "scaleType": "Automatic" - }, + "locations": [ + "centralindia" + ], + "resourceType": "service", "restrictions": [] }, { - "resourceType": "service", "name": "Basic", - "locations": [ - "centralindia" - ], + "capacity": { + "default": 1, + "maximum": 2, + "minimum": 1, + "scaleType": "Manual" + }, "locationInfo": [ { "location": "centralindia", - "zones": [], - "zoneDetails": [] + "zoneDetails": [], + "zones": [] } ], - "capacity": { - "minimum": 1, - "maximum": 2, - "default": 1, - "scaleType": "Manual" - }, + "locations": [ + "centralindia" + ], + "resourceType": "service", "restrictions": [] }, { - "resourceType": "service", "name": "Consumption", - "locations": [ - "centralindia" - ], + "capacity": { + "default": 0, + "maximum": 0, + "minimum": 0, + "scaleType": "None" + }, "locationInfo": [ { "location": "centralindia", - "zones": [], - "zoneDetails": [] + "zoneDetails": [], + "zones": [] } ], - "capacity": { - "minimum": 0, - "maximum": 0, - "default": 0, - "scaleType": "None" - }, + "locations": [ + "centralindia" + ], + "resourceType": "service", "restrictions": [] }, { - "resourceType": "service", "name": "Developer", - "locations": [ - "uaenorth" - ], + "capacity": { + "default": 1, + "maximum": 1, + "minimum": 1, + "scaleType": "None" + }, "locationInfo": [ { "location": "uaenorth", - "zones": [], - "zoneDetails": [] + "zoneDetails": [], + "zones": [] } ], - "capacity": { - "minimum": 1, - "maximum": 1, - "default": 1, - "scaleType": "None" - }, + "locations": [ + "uaenorth" + ], + "resourceType": "service", "restrictions": [] }, { - "resourceType": "service", "name": "Standard", - "locations": [ - "uaenorth" - ], + "capacity": { + "default": 1, + "maximum": 4, + "minimum": 1, + "scaleType": "Automatic" + }, "locationInfo": [ { "location": "uaenorth", - "zones": [], - "zoneDetails": [] + "zoneDetails": [], + "zones": [] } ], - "capacity": { - "minimum": 1, - "maximum": 4, - "default": 1, - "scaleType": "Automatic" - }, + "locations": [ + "uaenorth" + ], + "resourceType": "service", "restrictions": [] }, { - "resourceType": "service", "name": "Premium", - "locations": [ - "uaenorth" - ], + "capacity": { + "default": 1, + "maximum": 10, + "minimum": 1, + "scaleType": "Automatic" + }, "locationInfo": [ { "location": "uaenorth", - "zones": [], - "zoneDetails": [] + "zoneDetails": [], + "zones": [] } ], - "capacity": { - "minimum": 1, - "maximum": 10, - "default": 1, - "scaleType": "Automatic" - }, + "locations": [ + "uaenorth" + ], + "resourceType": "service", "restrictions": [] }, { - "resourceType": "service", "name": "Basic", - "locations": [ - "uaenorth" - ], + "capacity": { + "default": 1, + "maximum": 2, + "minimum": 1, + "scaleType": "Manual" + }, "locationInfo": [ { "location": "uaenorth", - "zones": [], - "zoneDetails": [] + "zoneDetails": [], + "zones": [] } ], - "capacity": { - "minimum": 1, - "maximum": 2, - "default": 1, - "scaleType": "Manual" - }, + "locations": [ + "uaenorth" + ], + "resourceType": "service", "restrictions": [] }, { - "resourceType": "service", "name": "Developer", - "locations": [ - "australiacentral" - ], + "capacity": { + "default": 1, + "maximum": 1, + "minimum": 1, + "scaleType": "None" + }, "locationInfo": [ { "location": "australiacentral", - "zones": [], - "zoneDetails": [] + "zoneDetails": [], + "zones": [] } ], - "capacity": { - "minimum": 1, - "maximum": 1, - "default": 1, - "scaleType": "None" - }, + "locations": [ + "australiacentral" + ], + "resourceType": "service", "restrictions": [] } ] } } - } + }, + "operationId": "ApiManagementSkus_List", + "title": "Lists all available Resource SKUs" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSubscriptions.json index 1893b7b3224c..42e3fa03815e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSubscriptions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListSubscriptions.json @@ -1,56 +1,58 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5600b59475ff190048070001", - "type": "Microsoft.ApiManagement/service/subscriptions", "name": "5600b59475ff190048070001", + "type": "Microsoft.ApiManagement/service/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5600b59475ff190048070001", "properties": { + "createdDate": "2015-09-22T01:57:40.3Z", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001", - "state": "active", - "createdDate": "2015-09-22T01:57:40.3Z" + "state": "active" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/56eaed3dbaf08b06e46d27fe", - "type": "Microsoft.ApiManagement/service/subscriptions", "name": "56eaed3dbaf08b06e46d27fe", + "type": "Microsoft.ApiManagement/service/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/56eaed3dbaf08b06e46d27fe", "properties": { + "createdDate": "2016-03-17T17:45:33.837Z", + "displayName": "Starter", + "expirationDate": "2016-04-01T00:00:00Z", + "notificationDate": "2016-03-20T00:00:00Z", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001", - "displayName": "Starter", - "state": "active", - "createdDate": "2016-03-17T17:45:33.837Z", "startDate": "2016-03-17T00:00:00Z", - "expirationDate": "2016-04-01T00:00:00Z", - "notificationDate": "2016-03-20T00:00:00Z" + "state": "active" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8", - "type": "Microsoft.ApiManagement/service/subscriptions", "name": "5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8", "properties": { + "createdDate": "2017-06-02T17:59:06.223Z", + "displayName": "Unlimited", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", - "displayName": "Unlimited", - "state": "submitted", - "createdDate": "2017-06-02T17:59:06.223Z" + "state": "submitted" } } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "Subscription_List", + "title": "ApiManagementListSubscriptions" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagApiLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagApiLinks.json index e554064be70f..5437aa26e4cd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagApiLinks.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagApiLinks.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagId": "tag1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/tags/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "TagApiLink_ListByProduct", + "title": "ApiManagementListTagApiLinks" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagOperationLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagOperationLinks.json index dc8ac9262381..0c3698a41475 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagOperationLinks.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagOperationLinks.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagId": "tag1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", - "type": "Microsoft.ApiManagement/service/tags/operationLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/operationLinks/link1", "properties": { "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/op1" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "TagOperationLink_ListByProduct", + "title": "ApiManagementListTagOperationLinks" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagProductLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagProductLinks.json index 61fdc740521f..9189f87c9912 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagProductLinks.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagProductLinks.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "tagId": "tag1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", - "type": "Microsoft.ApiManagement/service/tags/productLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tag1/productLinks/link1", "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "TagProductLink_ListByProduct", + "title": "ApiManagementListTagProductLinks" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagResources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagResources.json index 7e5a89cc3a50..5b7d1d6a546f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagResources.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTagResources.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -10,52 +10,54 @@ "body": { "value": [ { - "tag": { - "id": "/tags/apitag123", - "name": "awesomeTag" - }, "operation": { - "id": "/apis/echo-api/operations/create-resource", - "apiName": "Echo API", - "apiRevision": "1", "name": "Create resource", "method": "POST", - "urlTemplate": "/resource", - "description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend." + "description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend.", + "apiName": "Echo API", + "apiRevision": "1", + "id": "/apis/echo-api/operations/create-resource", + "urlTemplate": "/resource" + }, + "tag": { + "name": "awesomeTag", + "id": "/tags/apitag123" } }, { - "tag": { - "id": "/tags/apitag123", - "name": "awesomeTag" - }, "api": { - "id": "/apis/echo-api", "name": "Echo API", - "apiRevision": "1", - "serviceUrl": "http://echoapi.cloudapp.net/api", "path": "echo", - "isCurrent": true + "apiRevision": "1", + "id": "/apis/echo-api", + "isCurrent": true, + "serviceUrl": "http://echoapi.cloudapp.net/api" + }, + "tag": { + "name": "awesomeTag", + "id": "/tags/apitag123" } }, { - "tag": { - "id": "/tags/apitag123", - "name": "awesomeTag" - }, "product": { - "id": "/products/starter", "name": "Starter", "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", - "terms": "", - "subscriptionRequired": true, "approvalRequired": false, + "id": "/products/starter", + "state": "published", + "subscriptionRequired": true, "subscriptionsLimit": 1, - "state": "published" + "terms": "" + }, + "tag": { + "name": "awesomeTag", + "id": "/tags/apitag123" } } ] } } - } + }, + "operationId": "TagResource_ListByService", + "title": "ApiManagementListTagResources" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTags.json index ff5d12edd0cc..a698fa1b5ec2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTags.json @@ -1,34 +1,36 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020001", - "type": "Microsoft.ApiManagement/service/tags", "name": "5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020001", "properties": { "displayName": "tag1" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020002", - "type": "Microsoft.ApiManagement/service/tags", "name": "5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020002", "properties": { "displayName": "tag2" } } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "Tag_ListByService", + "title": "ApiManagementListTags" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTemplates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTemplates.json index 6174c53a1962..e84d6a156393 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTemplates.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTemplates.json @@ -1,23 +1,23 @@ { "parameters": { + "api-version": "2024-10-01-preview", "resourceGroupName": "rg1", "serviceName": "apimService1", - "api-version": "2024-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/ApplicationApprovedNotificationMessage", - "type": "Microsoft.ApiManagement/service/templates", "name": "ApplicationApprovedNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/ApplicationApprovedNotificationMessage", "properties": { - "subject": "Your application $AppName is published in the application gallery", - "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

\r\n We are happy to let you know that your request to publish the $AppName application in the application gallery has been approved. Your application has been published and can be viewed here.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", - "title": "Application gallery submission approved", "description": "Developers who submitted their application for publication in the application gallery on the developer portal receive this email after their submission is approved.", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

\r\n We are happy to let you know that your request to publish the $AppName application in the application gallery has been approved. Your application has been published and can be viewed here.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", "isDefault": true, "parameters": [ { @@ -44,13 +44,15 @@ "name": "DevPortalUrl", "title": "Developer portal URL" } - ] + ], + "subject": "Your application $AppName is published in the application gallery", + "title": "Application gallery submission approved" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "EmailTemplate_ListByService", + "title": "ApiManagementListTemplates" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTenantAccess.json index 7f9e325ee9cc..eb581e057bd2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTenantAccess.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTenantAccess.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", - "type": "Microsoft.ApiManagement/service/tenant", "name": "access", + "type": "Microsoft.ApiManagement/service/tenant", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", "properties": { "enabled": true } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "TenantAccess_ListByService", + "title": "ApiManagementListTenantAccess" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTenantSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTenantSettings.json index 03dea82b205d..e1773154c68a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTenantSettings.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListTenantSettings.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/settings/public", - "type": "Microsoft.ApiManagement/service/settings", "name": "public", + "type": "Microsoft.ApiManagement/service/settings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/settings/public", "properties": { "settings": { - "CustomPortalSettings.UserRegistrationTerms": null, - "CustomPortalSettings.UserRegistrationTermsEnabled": "False", - "CustomPortalSettings.UserRegistrationTermsConsentRequired": "False", + "CustomPortalSettings.DelegatedSubscriptionEnabled": "False", "CustomPortalSettings.DelegationEnabled": "False", "CustomPortalSettings.DelegationUrl": "", - "CustomPortalSettings.DelegatedSubscriptionEnabled": "False" + "CustomPortalSettings.UserRegistrationTerms": null, + "CustomPortalSettings.UserRegistrationTermsConsentRequired": "False", + "CustomPortalSettings.UserRegistrationTermsEnabled": "False" } } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "TenantSettings_ListByService", + "title": "ApiManagementListTenantSettings" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUserGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUserGroups.json index bd95d1c1a7e6..552239b48973 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUserGroups.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUserGroups.json @@ -1,30 +1,32 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "userId": "57681833a40f7eb6c49f6acf" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/groups/5600b57e7e8880006a020002", - "type": "Microsoft.ApiManagement/service/users/groups", "name": "5600b57e7e8880006a020002", + "type": "Microsoft.ApiManagement/service/users/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/groups/5600b57e7e8880006a020002", "properties": { - "displayName": "Developers", + "type": "system", "description": "Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.", "builtIn": true, - "type": "system" + "displayName": "Developers" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "UserGroup_List", + "title": "ApiManagementListUserGroups" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUserIdentities.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUserIdentities.json index f1973ffce883..4f6c7d3027d4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUserIdentities.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUserIdentities.json @@ -1,22 +1,24 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "userId": "57f2af53bb17172280f44057" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "provider": "Microsoft", - "id": "086cf9********55ab" + "id": "086cf9********55ab", + "provider": "Microsoft" } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "UserIdentities_List", + "title": "ApiManagementListUserIdentities" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUserSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUserSubscriptions.json index a13b324e7cd1..aabbb1a3eacc 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUserSubscriptions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUserSubscriptions.json @@ -1,44 +1,46 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "userId": "57681833a40f7eb6c49f6acf" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6ae3", - "type": "Microsoft.ApiManagement/service/users/subscriptions", "name": "57681850a40f7eb6c49f6ae3", + "type": "Microsoft.ApiManagement/service/users/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6ae3", "properties": { + "createdDate": "2016-06-20T16:22:39.547Z", + "displayName": "57681850a40f7eb6c49f6ae5", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7", - "displayName": "57681850a40f7eb6c49f6ae5", - "state": "active", - "createdDate": "2016-06-20T16:22:39.547Z", - "startDate": "2016-06-20T00:00:00Z" + "startDate": "2016-06-20T00:00:00Z", + "state": "active" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6b2b", - "type": "Microsoft.ApiManagement/service/users/subscriptions", "name": "57681850a40f7eb6c49f6b2b", + "type": "Microsoft.ApiManagement/service/users/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6b2b", "properties": { + "createdDate": "2016-06-20T16:22:41.103Z", + "displayName": "57681850a40f7eb6c49f6b2d", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7", - "displayName": "57681850a40f7eb6c49f6b2d", - "state": "active", - "createdDate": "2016-06-20T16:22:41.103Z", - "startDate": "2016-06-20T00:00:00Z" + "startDate": "2016-06-20T00:00:00Z", + "state": "active" } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "UserSubscription_List", + "title": "ApiManagementListUserSubscriptions" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUsers.json index 91d38e573f32..93ea3d563fbf 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUsers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListUsers.json @@ -1,72 +1,74 @@ { "parameters": { + "api-version": "2024-10-01-preview", "resourceGroupName": "rg1", "serviceName": "apimService1", - "api-version": "2024-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", - "type": "Microsoft.ApiManagement/service/users", "name": "1", + "type": "Microsoft.ApiManagement/service/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", "properties": { - "firstName": "Administrator", - "lastName": "", "email": "admin@live.com", - "state": "active", - "registrationDate": "2015-09-22T01:57:39.677Z", + "firstName": "Administrator", "identities": [ { - "provider": "Azure", - "id": "admin@live.com" + "id": "admin@live.com", + "provider": "Azure" } - ] + ], + "lastName": "", + "registrationDate": "2015-09-22T01:57:39.677Z", + "state": "active" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd", - "type": "Microsoft.ApiManagement/service/users", "name": "56eaec62baf08b06e46d27fd", + "type": "Microsoft.ApiManagement/service/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd", "properties": { - "firstName": "foo", - "lastName": "bar", "email": "foo.bar.83@gmail.com", - "state": "active", - "registrationDate": "2016-03-17T17:41:56.327Z", + "firstName": "foo", "identities": [ { - "provider": "Basic", - "id": "foo.bar.83@gmail.com" + "id": "foo.bar.83@gmail.com", + "provider": "Basic" } - ] + ], + "lastName": "bar", + "registrationDate": "2016-03-17T17:41:56.327Z", + "state": "active" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", - "type": "Microsoft.ApiManagement/service/users", "name": "5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", "properties": { - "firstName": "foo", - "lastName": "bar", "email": "foobar@outlook.com", - "state": "active", - "registrationDate": "2017-06-02T17:58:50.357Z", + "firstName": "foo", "identities": [ { - "provider": "Microsoft", - "id": "*************" + "id": "*************", + "provider": "Microsoft" } - ] + ], + "lastName": "bar", + "registrationDate": "2017-06-02T17:58:50.357Z", + "state": "active" } } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "User_ListByService", + "title": "ApiManagementListUsers" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiDiagnostics.json index 2fe2127e5104..f2756800e312 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiDiagnostics.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiDiagnostics.json @@ -1,62 +1,64 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "apiId": "echo-api", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "apiId": "echo-api" + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "httpCorrelationProtocol": "Legacy", - "logClientIp": true, - "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", - "sampling": { - "samplingType": "fixed", - "percentage": 100 - }, - "frontend": { - "request": { - "headers": [], + "backend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } }, - "backend": { - "request": { - "headers": [], + "frontend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" } } } - ], - "count": 1 + ] } } - } + }, + "operationId": "WorkspaceApiDiagnostic_ListByWorkspace", + "title": "ApiManagementListWorkspaceApiDiagnostics" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiOperationPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiOperationPolicies.json index b3dc695f75a6..dd4bf9a817f7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiOperationPolicies.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiOperationPolicies.json @@ -1,29 +1,31 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "operationId": "599e29ab193c3c0bd0b3e2fb", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "599e2953193c3c0bd0b3e2fa", - "operationId": "599e29ab193c3c0bd0b3e2fb" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/599e2953193c3c0bd0b3e2fa/operations/599e29ab193c3c0bd0b3e2fb/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/599e2953193c3c0bd0b3e2fa/operations/599e29ab193c3c0bd0b3e2fb/policies/policy", "properties": { "value": "\r\n\r\n \r\n \r\n \r\n \r\n xxx\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceApiOperationPolicy_ListByOperation", + "title": "ApiManagementListWorkspaceApiOperationPolicies" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiOperations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiOperations.json index 6c1863b689cd..9637aec50ba6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiOperations.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiOperations.json @@ -1,70 +1,72 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "apiId": "57d2ef278aa04f0888cba3f3" + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 5, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", "properties": { - "displayName": "CancelOrder", "method": "POST", + "displayName": "CancelOrder", "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda", - "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", "name": "57d2ef278aa04f0ad01d6cda", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda", "properties": { - "displayName": "GetMostRecentOrder", "method": "POST", + "displayName": "GetMostRecentOrder", "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetMostRecentOrder" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9", - "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", "name": "57d2ef278aa04f0ad01d6cd9", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9", "properties": { - "displayName": "GetOpenOrders", "method": "POST", + "displayName": "GetOpenOrders", "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOpenOrders" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb", - "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", "name": "57d2ef278aa04f0ad01d6cdb", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb", "properties": { - "displayName": "GetOrder", "method": "POST", + "displayName": "GetOrder", "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOrder" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8", - "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", "name": "57d2ef278aa04f0ad01d6cd8", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8", "properties": { - "displayName": "submitOrder", "method": "POST", + "displayName": "submitOrder", "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/submitOrder" } } - ], - "count": 5, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceApiOperation_ListByApi", + "title": "ApiManagementListWorkspaceApiOperations" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiPolicies.json index a3a3880e6060..0623a1c37e1d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiPolicies.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiPolicies.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "apiId": "5600b59475ff190048040001", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "apiId": "5600b59475ff190048040001" + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b59475ff190048040001/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/apis/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5600b59475ff190048040001/policies/policy", "properties": { "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceApiPolicy_ListByApi", + "title": "ApiManagementListWorkspaceApiPolicies" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiReleases.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiReleases.json index f9f8cdda17be..2b4895605448 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiReleases.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiReleases.json @@ -1,30 +1,32 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "apiId": "a1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "apiId": "a1" + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/5a7cb545298324c53224a799", - "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", "name": "5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/5a7cb545298324c53224a799", "properties": { "createdDateTime": "2018-02-08T20:38:29.173Z", - "updatedDateTime": "2018-02-08T20:38:29.173Z", - "notes": "yahoo" + "notes": "yahoo", + "updatedDateTime": "2018-02-08T20:38:29.173Z" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceApiRelease_ListByService", + "title": "ApiManagementListWorkspaceApiReleases" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiRevisions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiRevisions.json index 5f2adeb22383..fa06426b8e71 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiRevisions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiRevisions.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "apiId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "apiId": "57d2ef278aa04f0888cba3f3" + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1;rev=1", "apiRevision": "1", "createdDateTime": "2018-02-01T22:21:20.467Z", - "updatedDateTime": "2018-02-01T22:21:20.467Z", + "isCurrent": true, "isOnline": true, - "isCurrent": true + "updatedDateTime": "2018-02-01T22:21:20.467Z" } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceApiRevision_ListByService", + "title": "ApiManagementListWorkspaceApiRevisions" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiSchemas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiSchemas.json index 23fba7263def..b830d651e81e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiSchemas.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiSchemas.json @@ -1,20 +1,22 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "apiId": "59d5b28d1f7fab116c282650", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "apiId": "59d5b28d1f7fab116c282650" + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d5b28d1f7fab116c282650/schemas/59d5b28e1f7fab116402044e", - "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", "name": "59d5b28e1f7fab116402044e", + "type": "Microsoft.ApiManagement/service/workspaces/apis/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/59d5b28d1f7fab116c282650/schemas/59d5b28e1f7fab116402044e", "properties": { "contentType": "application/vnd.ms-azure-apim.xsd+xml", "document": { @@ -22,10 +24,10 @@ } } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceApiSchema_ListByApi", + "title": "ApiManagementListWorkspaceApiSchemas" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiVersionSets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiVersionSets.json index 374d0f870989..edd1ce225915 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiVersionSets.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApiVersionSets.json @@ -1,39 +1,41 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs1", - "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", "name": "vs1", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs1", "properties": { + "description": "Version configuration", "displayName": "api set 1", - "versioningScheme": "Segment", - "description": "Version configuration" + "versioningScheme": "Segment" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs2", - "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", "name": "vs2", + "type": "Microsoft.ApiManagement/service/workspaces/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs2", "properties": { + "description": "Version configuration 2", "displayName": "api set 2", - "versioningScheme": "Query", - "description": "Version configuration 2" + "versioningScheme": "Query" } } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceApiVersionSet_ListByService", + "title": "ApiManagementListWorkspaceApiVersionSets" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApis.json index 3888731ce207..61b7e7aa47b0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceApis.json @@ -1,83 +1,85 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 4, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", - "type": "Microsoft.ApiManagement/service/workspaces/apis", "name": "a1", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", "properties": { - "displayName": "api1", - "apiRevision": "1", - "serviceUrl": "http://echoapi.cloudapp.net/api", "path": "api1", + "apiRevision": "1", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4", + "displayName": "api1", + "isCurrent": true, "protocols": [ "https" ], - "isCurrent": true, - "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4" + "serviceUrl": "http://echoapi.cloudapp.net/api" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5a73933b8f27f7cc82a2d533", - "type": "Microsoft.ApiManagement/service/workspaces/apis", "name": "5a73933b8f27f7cc82a2d533", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5a73933b8f27f7cc82a2d533", "properties": { - "displayName": "api1", - "apiRevision": "1", - "serviceUrl": "http://echoapi.cloudapp.net/api", "path": "api1", + "apiRevision": "1", + "apiVersion": "v1", + "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4", + "displayName": "api1", + "isCurrent": true, "protocols": [ "https" ], - "isCurrent": true, - "apiVersion": "v1", - "apiVersionSetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4" + "serviceUrl": "http://echoapi.cloudapp.net/api" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api", - "type": "Microsoft.ApiManagement/service/workspaces/apis", "name": "echo-api", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api", "properties": { - "displayName": "Echo API", - "apiRevision": "1", - "serviceUrl": "http://echoapi.cloudapp.net/api", "path": "echo", + "apiRevision": "1", + "displayName": "Echo API", + "isCurrent": true, "protocols": [ "https" ], - "isCurrent": true + "serviceUrl": "http://echoapi.cloudapp.net/api" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5a7390baa5816a110435aee0", - "type": "Microsoft.ApiManagement/service/workspaces/apis", "name": "5a7390baa5816a110435aee0", + "type": "Microsoft.ApiManagement/service/workspaces/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/5a7390baa5816a110435aee0", "properties": { - "displayName": "Swagger Petstore Extensive", - "apiRevision": "1", - "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", - "serviceUrl": "http://petstore.swagger.wordnik.com/api", "path": "vvv", + "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", + "apiRevision": "1", + "displayName": "Swagger Petstore Extensive", + "isCurrent": true, "protocols": [ "https" ], - "isCurrent": true + "serviceUrl": "http://petstore.swagger.wordnik.com/api" } } - ], - "count": 4, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceApi_ListByService", + "title": "ApiManagementListWorkspaceApis" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceBackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceBackends.json index dc7e8635d84c..943de3fec485 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceBackends.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceBackends.json @@ -1,30 +1,27 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", - "type": "Microsoft.ApiManagement/service/workspaces/backends", "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", "properties": { "description": "description5308", - "url": "https://backendname2644/", - "protocol": "http", "credentials": { - "query": { - "sv": [ - "xx", - "bb", - "cc" - ] + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" }, "header": { "x-my-1": [ @@ -32,51 +29,56 @@ "val2" ] }, - "authorization": { - "scheme": "Basic", - "parameter": "opensesma" + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] } }, "proxy": { + "password": "", "url": "http://192.168.1.1:8080", - "username": "Contoso\\admin", - "password": "" + "username": "Contoso\\admin" }, "tls": { "validateCertificateChain": false, "validateCertificateName": false - } + }, + "url": "https://backendname2644/", + "protocol": "http" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", - "type": "Microsoft.ApiManagement/service/workspaces/backends", "name": "sfbackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend", "properties": { "description": "Service Fabric Test App 1", - "url": "fabric:/mytestapp/mytestservice", - "protocol": "http", "properties": { "serviceFabricCluster": { + "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", "managementEndpoints": [ "https://somecluster.com" ], - "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1", + "maxPartitionResolutionRetries": 5, "serverX509Names": [ { "name": "ServerCommonName1", "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" } - ], - "maxPartitionResolutionRetries": 5 + ] } - } + }, + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http" } } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceBackend_ListByWorkspace", + "title": "ApiManagementListWorkspaceBackends" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceCertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceCertificates.json index cc678664f0a4..6bb1fc4323e8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceCertificates.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceCertificates.json @@ -1,47 +1,49 @@ { "parameters": { + "api-version": "2024-10-01-preview", "resourceGroupName": "rg1", "serviceName": "apimService1", - "api-version": "2024-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/kjoshiarmtemplateCert1", - "type": "Microsoft.ApiManagement/service/workspaces/certificates", "name": "templateCert1", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/kjoshiarmtemplateCert1", "properties": { + "expirationDate": "2017-04-23T17:03:41Z", "subject": "CN=mutual-authcert", - "thumbprint": "EBA************************48594A6", - "expirationDate": "2017-04-23T17:03:41Z" + "thumbprint": "EBA************************48594A6" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", - "type": "Microsoft.ApiManagement/service/workspaces/certificates", "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", "properties": { - "subject": "CN=*.msitesting.net", - "thumbprint": "EA**********************9AD690", "expirationDate": "2037-01-01T07:00:00Z", "keyVault": { - "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-22T00:24:53.3191468Z" - } - } + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" } } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceCertificate_ListByWorkspace", + "title": "ApiManagementListWorkspaceCertificates" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceDiagnostics.json index 9a91dd2abd6d..08702184667b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceDiagnostics.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceDiagnostics.json @@ -1,75 +1,77 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "httpCorrelationProtocol": "Legacy", - "verbosity": "information", - "logClientIp": true, - "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", - "sampling": { - "samplingType": "fixed", - "percentage": 100 - }, - "frontend": { - "request": { - "headers": [], + "backend": { + "response": { "body": { "bytes": 0 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 0 - } + }, + "headers": [] } }, - "backend": { - "request": { - "headers": [], + "frontend": { + "response": { "body": { "bytes": 0 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 0 - } + }, + "headers": [] } - } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" + }, + "verbosity": "information" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/azuremonitor", - "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", "name": "azuremonitor", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/azuremonitor", "properties": { "logClientIp": true, "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/azuremonitor", "sampling": { - "samplingType": "fixed", - "percentage": 100 + "percentage": 100, + "samplingType": "fixed" } } } - ], - "count": 1 + ] } } - } + }, + "operationId": "WorkspaceDiagnostic_ListByWorkspace", + "title": "ApiManagementListWorkspaceDiagnostics" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceGroupUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceGroupUsers.json index 4a9cd593c32a..2dc7f465ded3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceGroupUsers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceGroupUsers.json @@ -1,39 +1,41 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "groupId": "57d2ef278aa04f0888cba3f3", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "groupId": "57d2ef278aa04f0888cba3f3" + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/kjoshiarmTemplateUser1", - "type": "Microsoft.ApiManagement/service/workspaces/groups/users", "name": "armTemplateUser1", + "type": "Microsoft.ApiManagement/service/workspaces/groups/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/users/kjoshiarmTemplateUser1", "properties": { - "firstName": "user1", - "lastName": "lastname1", "email": "user1@live.com", - "state": "active", - "registrationDate": "2017-05-31T18:54:41.447Z", - "note": "note for user 1", + "firstName": "user1", "identities": [ { - "provider": "Basic", - "id": "user1@live.com" + "id": "user1@live.com", + "provider": "Basic" } - ] + ], + "lastName": "lastname1", + "note": "note for user 1", + "registrationDate": "2017-05-31T18:54:41.447Z", + "state": "active" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceGroupUser_List", + "title": "ApiManagementListWorkspaceGroupUsers" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceGroups.json index 9b9a5215ba0d..ee68125107ad 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceGroups.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceGroups.json @@ -1,31 +1,33 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/59306a29e4bbd510dc24e5f9", - "type": "Microsoft.ApiManagement/service/workspaces/groups", "name": "59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/59306a29e4bbd510dc24e5f9", "properties": { - "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "type": "external", "description": "awesome group of people", "builtIn": false, - "type": "external", + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceGroup_ListByService", + "title": "ApiManagementListWorkspaceGroups" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceLinks.json index f36005519695..da7e8dd6b55b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceLinks.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceLinks.json @@ -1,35 +1,34 @@ { "parameters": { - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "serviceName": "service1" + "resourceGroupName": "rg1", + "serviceName": "service1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/service-1/workspaceLinks/wk-1", "name": "wk-1", "type": "Microsoft.ApiManagement/service/workspaceLinks", "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/service-1/workspaceLinks/wk-1", "properties": { - "workspaceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/service-1/workspaces/wk-1", "gateways": [ { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/gateway-1" } - ] + ], + "workspaceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/service-1/workspaces/wk-1" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/service-1/workspaceLinks/wk-2", "name": "wk-1", "type": "Microsoft.ApiManagement/service/workspaceLinks", "etag": "AAAAAAAWKwo=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/service-1/workspaceLinks/wk-2", "properties": { - "workspaceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/service-1/workspaces/wk-2", "gateways": [ { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/gateway-1" @@ -37,11 +36,14 @@ { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/gateway-2" } - ] + ], + "workspaceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/service-1/workspaces/wk-2" } } ] } } - } + }, + "operationId": "ApiManagementWorkspaceLinks_ListByService", + "title": "ApiManagementListGatewayConfigConnection" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceLoggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceLoggers.json index 7ba03c1db634..cfd4b9437ab7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceLoggers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceLoggers.json @@ -1,53 +1,55 @@ { "parameters": { + "api-version": "2024-10-01-preview", "resourceGroupName": "rg1", "serviceName": "apimService1", - "api-version": "2024-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/azuremonitor", - "type": "Microsoft.ApiManagement/service/workspaces/loggers", "name": "azuremonitor", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/azuremonitor", "properties": { - "loggerType": "azureMonitor", - "isBuffered": true + "isBuffered": true, + "loggerType": "azureMonitor" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/vvktest", - "type": "Microsoft.ApiManagement/service/workspaces/loggers", "name": "vvktest", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/vvktest", "properties": { - "loggerType": "applicationInsights", "credentials": { "instrumentationKey": "{{Logger-Credentials-5b1a17ef2b3f91153004b10d}}" }, - "isBuffered": true + "isBuffered": true, + "loggerType": "applicationInsights" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/applicationinsights", - "type": "Microsoft.ApiManagement/service/workspaces/loggers", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/applicationinsights", "properties": { - "loggerType": "applicationInsights", "description": "miaoappinsight", "credentials": { "instrumentationKey": "{{Logger-Credentials-5b2056062b3f911ae84a3069}}" }, - "isBuffered": true + "isBuffered": true, + "loggerType": "applicationInsights" } } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceLogger_ListByWorkspace", + "title": "ApiManagementListWorkspaceLoggers" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNamedValues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNamedValues.json index 5794dd34d9ca..9f2cddd78cce 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNamedValues.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNamedValues.json @@ -1,50 +1,52 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/592f1174cc83890dc4f32686", - "type": "Microsoft.ApiManagement/service/workspaces/namedValues", "name": "592f1174cc83890dc4f32686", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/592f1174cc83890dc4f32686", "properties": { "displayName": "Logger-Credentials-592f1174cc83890dc4f32687", - "value": "propValue", - "secret": false + "secret": false, + "value": "propValue" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", - "type": "Microsoft.ApiManagement/service/workspaces/namedValues", "name": "testprop6", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", "properties": { "displayName": "prop6namekv", "keyVault": { - "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret", "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-11T00:54:31.8024882Z" - } + }, + "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret" }, + "secret": true, "tags": [ "foo", "bar" - ], - "secret": true + ] } } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceNamedValue_ListByService", + "title": "ApiManagementListWorkspaceNamedValues" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientEmails.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientEmails.json index db84ae641bc9..df2237f5036f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientEmails.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientEmails.json @@ -1,44 +1,46 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "notificationName": "RequestPublisherNotificationMessage" + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", - "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", "name": "contoso@live.com", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", "properties": { "email": "contoso@live.com" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", - "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", "name": "foobar!live", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", "properties": { "email": "foobar!live" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", - "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", "name": "foobar@live.com", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", "properties": { "email": "foobar@live.com" } } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceNotificationRecipientEmail_ListByNotification", + "title": "ApiManagementListWorkspaceNotificationRecipientEmails" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientUsers.json index c809a8df3a19..7fa6573e0c96 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientUsers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNotificationRecipientUsers.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "notificationName": "RequestPublisherNotificationMessage", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "notificationName": "RequestPublisherNotificationMessage" + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", - "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientUsers", "name": "576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientUsers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", "properties": { "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceNotificationRecipientUser_ListByNotification", + "title": "ApiManagementListWorkspaceNotificationRecipientUsers" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNotifications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNotifications.json index 2b49d5b5b068..9f607368102b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNotifications.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceNotifications.json @@ -1,21 +1,22 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage", - "type": "Microsoft.ApiManagement/service/workspaces/notifications", "name": "RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/workspaces/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage", "properties": { - "title": "Subscription requests (requiring approval)", "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", "recipients": { "emails": [ @@ -26,15 +27,15 @@ "users": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" ] - } + }, + "title": "Subscription requests (requiring approval)" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/PurchasePublisherNotificationMessage", - "type": "Microsoft.ApiManagement/service/workspaces/notifications", "name": "PurchasePublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/workspaces/notifications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/PurchasePublisherNotificationMessage", "properties": { - "title": "New subscriptions", "description": "The following email recipients and users will receive email notifications about new API product subscriptions.", "recipients": { "emails": [ @@ -43,13 +44,14 @@ "users": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" ] - } + }, + "title": "New subscriptions" } } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceNotification_ListByService", + "title": "ApiManagementListWorkspaceNotifications" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspacePolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspacePolicies.json index 0ac664098df3..57b94e3fc9b8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspacePolicies.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspacePolicies.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", "properties": { "value": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspacePolicy_ListByApi", + "title": "ApiManagementListWorkspacePolicies" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspacePolicyFragmentReferences.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspacePolicyFragmentReferences.json index d0916518d1be..d758a7665637 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspacePolicyFragmentReferences.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspacePolicyFragmentReferences.json @@ -1,25 +1,27 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "id": "policyFragment1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "id": "policyFragment1" + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy", + "name": "policy", "type": "Microsoft.ApiManagement/service/workspaces/policies", - "name": "policy" + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy" } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspacePolicyFragment_ListReferences", + "title": "ApiManagementListWorkspacePolicyFragmentReferences" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspacePolicyFragments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspacePolicyFragments.json index 65e55fc5278f..970cab78db74 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspacePolicyFragments.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspacePolicyFragments.json @@ -1,29 +1,31 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", - "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", "name": "policyFragment1", + "type": "Microsoft.ApiManagement/service/workspaces/policyFragments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1", "properties": { "format": "xml", "description": "A policy fragment example", "value": "" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspacePolicyFragment_ListByService", + "title": "ApiManagementListWorkspacePolicyFragments" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProductApiLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProductApiLinks.json index 97da92f3a643..a5adec52359e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProductApiLinks.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProductApiLinks.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "productId": "product1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "productId": "product1" + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/products/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceProductApiLink_ListByProduct", + "title": "ApiManagementListWorkspaceProductApiLinks" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProductGroupLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProductGroupLinks.json index fe793e9430c9..a88b0cc03c61 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProductGroupLinks.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProductGroupLinks.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "productId": "product1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "productId": "product1" + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1/groupLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces.products/groupLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces.products/groupLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1/groupLinks/link1", "properties": { "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/group1" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceProductGroupLink_ListByProduct", + "title": "ApiManagementListWorkspaceProductGroupLinks" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProductPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProductPolicies.json index 5bad62884955..8379e2289930 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProductPolicies.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProductPolicies.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "productId": "armTemplateProduct4", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "productId": "armTemplateProduct4" + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/armTemplateProduct4/policies/policy", - "type": "Microsoft.ApiManagement/service/workspaces/products/policies", "name": "policy", + "type": "Microsoft.ApiManagement/service/workspaces/products/policies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/armTemplateProduct4/policies/policy", "properties": { "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceProductPolicy_ListByProduct", + "title": "ApiManagementListWorkspaceProductPolicies" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProducts.json index 265fce9413ab..079895bc9f4a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProducts.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceProducts.json @@ -1,57 +1,59 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/kjoshiarmtemplateCert1", - "type": "Microsoft.ApiManagement/service/workspaces/products", "name": "kjoshiarmtemplateCert1", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/kjoshiarmtemplateCert1", "properties": { - "displayName": "Dev", "description": "Development Product", - "subscriptionRequired": false, - "state": "published" + "displayName": "Dev", + "state": "published", + "subscriptionRequired": false } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/starter", - "type": "Microsoft.ApiManagement/service/workspaces/products", "name": "starter", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/starter", "properties": { - "displayName": "Starter", "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", - "terms": "", - "subscriptionRequired": true, "approvalRequired": false, + "displayName": "Starter", + "state": "published", + "subscriptionRequired": true, "subscriptionsLimit": 1, - "state": "published" + "terms": "" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/unlimited", - "type": "Microsoft.ApiManagement/service/workspaces/products", "name": "unlimited", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/unlimited", "properties": { - "displayName": "Unlimited", "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", - "subscriptionRequired": true, "approvalRequired": true, - "subscriptionsLimit": 1, - "state": "published" + "displayName": "Unlimited", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1 } } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceProduct_ListByService", + "title": "ApiManagementListWorkspaceProducts" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceSchemas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceSchemas.json index 6dac9bf27e37..8d26ae021c90 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceSchemas.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceSchemas.json @@ -1,19 +1,21 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", - "type": "Microsoft.ApiManagement/service/workspaces/schemas", "name": "schema1", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema1", "properties": { "description": "sample schema description", "schemaType": "xml", @@ -21,18 +23,21 @@ } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema2", - "type": "Microsoft.ApiManagement/service/workspaces/schemas", "name": "schema2", + "type": "Microsoft.ApiManagement/service/workspaces/schemas", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/schemas/schema2", "properties": { "description": "sample schema description", - "schemaType": "json", "document": { + "type": "object", "$id": "https://example.com/person.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "Person", - "type": "object", "properties": { + "age": { + "type": "integer", + "description": "Age in years which must be equal to or greater than zero.", + "minimum": 0 + }, "firstName": { "type": "string", "description": "The person's first name." @@ -40,20 +45,17 @@ "lastName": { "type": "string", "description": "The person's last name." - }, - "age": { - "description": "Age in years which must be equal to or greater than zero.", - "type": "integer", - "minimum": 0 } - } - } + }, + "title": "Person" + }, + "schemaType": "json" } } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceGlobalSchema_ListByService", + "title": "ApiManagementListWorkspaceSchemas" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceSubscriptions.json index 4998219d469b..d1aa4e68aa80 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceSubscriptions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceSubscriptions.json @@ -1,57 +1,59 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 3, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/5600b59475ff190048070001", - "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", "name": "5600b59475ff190048070001", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/5600b59475ff190048070001", "properties": { + "createdDate": "2015-09-22T01:57:40.3Z", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060001", - "state": "active", - "createdDate": "2015-09-22T01:57:40.3Z" + "state": "active" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/56eaed3dbaf08b06e46d27fe", - "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", "name": "56eaed3dbaf08b06e46d27fe", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/56eaed3dbaf08b06e46d27fe", "properties": { + "createdDate": "2016-03-17T17:45:33.837Z", + "displayName": "Starter", + "expirationDate": "2016-04-01T00:00:00Z", + "notificationDate": "2016-03-20T00:00:00Z", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060001", - "displayName": "Starter", - "state": "active", - "createdDate": "2016-03-17T17:45:33.837Z", "startDate": "2016-03-17T00:00:00Z", - "expirationDate": "2016-04-01T00:00:00Z", - "notificationDate": "2016-03-20T00:00:00Z" + "state": "active" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/5931a769d8d14f0ad8ce13b8", - "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", "name": "5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/5931a769d8d14f0ad8ce13b8", "properties": { + "createdDate": "2017-06-02T17:59:06.223Z", + "displayName": "Unlimited", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", - "displayName": "Unlimited", - "state": "submitted", - "createdDate": "2017-06-02T17:59:06.223Z" + "state": "submitted" } } - ], - "count": 3, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceSubscription_List", + "title": "ApiManagementListWorkspaceSubscriptions" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTagApiLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTagApiLinks.json index 5f53fb5671bd..cdc48cd26480 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTagApiLinks.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTagApiLinks.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "tagId": "tag1" + "tagId": "tag1", + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/apiLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/apiLinks/link1", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceTagApiLink_ListByProduct", + "title": "ApiManagementListWorkspaceTagApiLinks" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTagOperationLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTagOperationLinks.json index f05bff1b2805..8b4bd93a8584 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTagOperationLinks.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTagOperationLinks.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "tagId": "tag1" + "tagId": "tag1", + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/operationLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/operationLinks/link1", "properties": { "operationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/operations/op1" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceTagOperationLink_ListByProduct", + "title": "ApiManagementListWorkspaceTagOperationLinks" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTagProductLinks.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTagProductLinks.json index aefa3256e8ef..c23b3cc51abb 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTagProductLinks.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTagProductLinks.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "tagId": "tag1" + "tagId": "tag1", + "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 1, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", - "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", "name": "link1", + "type": "Microsoft.ApiManagement/service/workspaces/tags/productLinks", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/tag1/productLinks/link1", "properties": { "productId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/product1" } } - ], - "count": 1, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceTagProductLink_ListByProduct", + "title": "ApiManagementListWorkspaceTagProductLinks" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTags.json index 6f867ed87baa..6fea841062c6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaceTags.json @@ -1,35 +1,37 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "workspaceId": "wks1" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/5600b59375ff190048020001", - "type": "Microsoft.ApiManagement/service/workspaces/tags", "name": "5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/5600b59375ff190048020001", "properties": { "displayName": "tag1" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/5600b59375ff190048020002", - "type": "Microsoft.ApiManagement/service/workspaces/tags", "name": "5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/5600b59375ff190048020002", "properties": { "displayName": "tag2" } } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "WorkspaceTag_ListByService", + "title": "ApiManagementListWorkspaceTags" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaces.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaces.json index 0f3539ebf003..4ae65a289d1b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaces.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementListWorkspaces.json @@ -1,36 +1,38 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "count": 2, + "nextLink": "", "value": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", - "type": "Microsoft.ApiManagement/service/workspaces", "name": "wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", "properties": { "description": "workspace 1", "displayName": "my workspace" } }, { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks2", - "type": "Microsoft.ApiManagement/service/workspaces", "name": "wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks2", "properties": { "description": "workspace 2", "displayName": "my workspace" } } - ], - "count": 2, - "nextLink": "" + ] } } - } + }, + "operationId": "Workspace_ListByService", + "title": "ApiManagementListWorkspaces" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementNamedValueListValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementNamedValueListValue.json index fc9244dad0ab..b9bffa813bbf 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementNamedValueListValue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementNamedValueListValue.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "namedValueId": "testarmTemplateproperties2" + "namedValueId": "testarmTemplateproperties2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "value": "propValue" } } - } + }, + "operationId": "NamedValue_ListValue", + "title": "ApiManagementNamedValueListValue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementOpenidConnectProviderListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementOpenidConnectProviderListSecrets.json index 4197ef569a76..460f3d105afa 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementOpenidConnectProviderListSecrets.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementOpenidConnectProviderListSecrets.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "opid": "templateOpenIdConnect2" + "opid": "templateOpenIdConnect2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -12,5 +12,7 @@ "clientSecret": "oidsecretproviderTemplate2" } } - } + }, + "operationId": "OpenIdConnectProvider_ListSecrets", + "title": "ApiManagementOpenidConnectProviderListSecrets" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPerformConnectivityCheck.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPerformConnectivityCheck.json index 3df81076826b..563b9fa6c6fa 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPerformConnectivityCheck.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPerformConnectivityCheck.json @@ -1,54 +1,56 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "connectivityCheckRequestParams": { - "source": { - "region": "northeurope" - }, "destination": { "address": "8.8.8.8", "port": 53 }, - "preferredIPVersion": "IPv4" - } - }, - "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/connectivityCheck/operationresults/bmljb2xhLW5ldHdvcmt3YXRjaGVyNF9Db25uZWN0aXRpdml0eUNoZWNrXzE2MmExNmZl?api-version=2024-10-01-preview" + "preferredIPVersion": "IPv4", + "source": { + "region": "northeurope" } }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { "200": { "body": { + "avgLatencyInMs": 1, + "connectionStatus": "Connected", "hops": [ { "type": "Source", - "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e", "address": "10.1.1.4", - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "issues": [], "nextHopIds": [ "75c8d819-b208-4584-a311-1aa45ce753f9" ], - "issues": [] + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1" }, { "type": "Internet", - "id": "75c8d819-b208-4584-a311-1aa45ce753f9", "address": "8.8.8.8", - "nextHopIds": [], - "issues": [] + "id": "75c8d819-b208-4584-a311-1aa45ce753f9", + "issues": [], + "nextHopIds": [] } ], - "connectionStatus": "Connected", - "avgLatencyInMs": 1, - "minLatencyInMs": 1, "maxLatencyInMs": 4, - "probesSent": 100, - "probesFailed": 0 + "minLatencyInMs": 1, + "probesFailed": 0, + "probesSent": 100 + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/connectivityCheck/operationresults/bmljb2xhLW5ldHdvcmt3YXRjaGVyNF9Db25uZWN0aXRpdml0eUNoZWNrXzE2MmExNmZl?api-version=2024-10-01-preview" } } - } + }, + "operationId": "PerformConnectivityCheckAsync", + "title": "TCP Connectivity Check" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPerformConnectivityCheckHttpConnect.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPerformConnectivityCheckHttpConnect.json index 0bb473c5cc77..473b300d4ec9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPerformConnectivityCheckHttpConnect.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPerformConnectivityCheckHttpConnect.json @@ -1,69 +1,71 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "connectivityCheckRequestParams": { - "source": { - "region": "northeurope" - }, "destination": { "address": "https://microsoft.com", "port": 3306 }, - "protocol": "HTTPS", "protocolConfiguration": { "HTTPConfiguration": { "method": "GET", - "validStatusCodes": [ - 200, - 204 - ], "headers": [ { "name": "Authorization", "value": "Bearer myPreciousToken" } + ], + "validStatusCodes": [ + 200, + 204 ] } - } - } + }, + "source": { + "region": "northeurope" + }, + "protocol": "HTTPS" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/connectivityCheck/operationresults/bmljb2xhLW5ldHdvcmt3YXRjaGVyNF9Db25uZWN0aXRpdml0eUNoZWNrXzE2MmExNmZl?api-version=2024-10-01-preview" - } - }, "200": { "body": { + "avgLatencyInMs": 260, + "connectionStatus": "Reachable", "hops": [ { "type": "Source", - "id": "c60e2296-5ebc-48cc-80e8-7e6d2981e7b2", "address": "20.82.216.48", - "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "id": "c60e2296-5ebc-48cc-80e8-7e6d2981e7b2", + "issues": [], "nextHopIds": [ "26aa44e7-04f1-462f-aa5d-5951957b5650" ], - "issues": [] + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1" }, { "type": "Internet", - "id": "26aa44e7-04f1-462f-aa5d-5951957b5650", "address": "40.113.200.201", - "nextHopIds": [], - "issues": [] + "id": "26aa44e7-04f1-462f-aa5d-5951957b5650", + "issues": [], + "nextHopIds": [] } ], - "connectionStatus": "Reachable", - "avgLatencyInMs": 260, - "minLatencyInMs": 250, "maxLatencyInMs": 281, - "probesSent": 3, - "probesFailed": 0 + "minLatencyInMs": 250, + "probesFailed": 0, + "probesSent": 3 + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/connectivityCheck/operationresults/bmljb2xhLW5ldHdvcmt3YXRjaGVyNF9Db25uZWN0aXRpdml0eUNoZWNrXzE2MmExNmZl?api-version=2024-10-01-preview" } } - } + }, + "operationId": "PerformConnectivityCheckAsync", + "title": "HTTP Connectivity Check" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalConfig.json index 8aed88481d60..1e296dceb7f1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalConfig.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalConfig.json @@ -1,27 +1,31 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "portalConfigId": "default" + "portalConfigId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", - "type": "Microsoft.ApiManagement/service/portalconfigs", "name": "default", + "type": "Microsoft.ApiManagement/service/portalconfigs", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", "properties": { - "enableBasicAuth": true, - "signin": { - "require": false + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] }, - "signup": { - "termsOfService": { - "text": "I agree to the service terms and conditions.", - "requireConsent": false - } + "csp": { + "allowedSources": [ + "*.contoso.com" + ], + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ] }, "delegation": { "delegateRegistration": false, @@ -29,22 +33,20 @@ "delegationUrl": null, "validationKey": null }, - "csp": { - "mode": "reportOnly", - "reportUri": [ - "https://report.contoso.com" - ], - "allowedSources": [ - "*.contoso.com" - ] + "enableBasicAuth": true, + "signin": { + "require": false }, - "cors": { - "allowedOrigins": [ - "https://contoso.com" - ] + "signup": { + "termsOfService": { + "requireConsent": false, + "text": "I agree to the service terms and conditions." + } } } } } - } + }, + "operationId": "PortalConfig_Get", + "title": "ApiManagementPortalConfig" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsGetDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsGetDelegation.json index e8ebd3f67149..45d9895ccd2c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsGetDelegation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsGetDelegation.json @@ -1,26 +1,28 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation", - "type": "Microsoft.ApiManagement/service/portalsettings", "name": "delegation", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation", "properties": { - "url": "http://contoso.com/delegation", "subscriptions": { "enabled": true }, + "url": "http://contoso.com/delegation", "userRegistration": { "enabled": true } } } } - } + }, + "operationId": "DelegationSettings_Get", + "title": "ApiManagementPortalSettingsGetDelegation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsGetSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsGetSignIn.json index b081447a1c1d..2239bf53e4eb 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsGetSignIn.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsGetSignIn.json @@ -1,20 +1,22 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin", - "type": "Microsoft.ApiManagement/service/portalsettings", "name": "signin", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin", "properties": { "enabled": true } } } - } + }, + "operationId": "SignInSettings_Get", + "title": "ApiManagementPortalSettingsGetSignIn" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsGetSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsGetSignUp.json index dbd5c226c651..525c73612beb 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsGetSignUp.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsGetSignUp.json @@ -1,25 +1,27 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup", - "type": "Microsoft.ApiManagement/service/portalsettings", "name": "signup", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup", "properties": { "enabled": true, "termsOfService": { - "text": "Terms of service text.", + "consentRequired": true, "enabled": true, - "consentRequired": true + "text": "Terms of service text." } } } } - } + }, + "operationId": "SignUpSettings_Get", + "title": "ApiManagementPortalSettingsGetSignUp" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsPutDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsPutDelegation.json index 2f5877eb5af9..b7dc44bcf22a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsPutDelegation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsPutDelegation.json @@ -1,40 +1,42 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userId": "5931a75ae4bbd512288c680b", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { - "url": "http://contoso.com/delegation", - "validationKey": "", "subscriptions": { "enabled": true }, + "url": "http://contoso.com/delegation", "userRegistration": { "enabled": true - } + }, + "validationKey": "" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation", - "type": "Microsoft.ApiManagement/service/portalsettings", "name": "delegation", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation", "properties": { - "url": "http://contoso.com/delegation", "subscriptions": { "enabled": true }, + "url": "http://contoso.com/delegation", "userRegistration": { "enabled": true } } } } - } + }, + "operationId": "DelegationSettings_CreateOrUpdate", + "title": "ApiManagementPortalSettingsUpdateDelegation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsPutSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsPutSignIn.json index 381ebaef3ff4..2b351fd10c85 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsPutSignIn.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsPutSignIn.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userId": "5931a75ae4bbd512288c680b", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "enabled": true } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin", - "type": "Microsoft.ApiManagement/service/portalsettings", "name": "signin", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin", "properties": { "enabled": true } } } - } + }, + "operationId": "SignInSettings_CreateOrUpdate", + "title": "ApiManagementPortalSettingsUpdateSignIn" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsPutSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsPutSignUp.json index fe9a3e2348ed..db1349327dee 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsPutSignUp.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsPutSignUp.json @@ -1,37 +1,39 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userId": "5931a75ae4bbd512288c680b", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "enabled": true, "termsOfService": { + "consentRequired": true, "enabled": true, - "text": "Terms of service text.", - "consentRequired": true + "text": "Terms of service text." } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup", - "type": "Microsoft.ApiManagement/service/portalsettings", "name": "signup", + "type": "Microsoft.ApiManagement/service/portalsettings", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup", "properties": { "enabled": true, "termsOfService": { - "text": "Terms of service text.", + "consentRequired": true, "enabled": true, - "consentRequired": true + "text": "Terms of service text." } } } } - } + }, + "operationId": "SignUpSettings_CreateOrUpdate", + "title": "ApiManagementPortalSettingsUpdateSignUp" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsUpdateDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsUpdateDelegation.json index b367b77370bf..47313a438e17 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsUpdateDelegation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsUpdateDelegation.json @@ -1,25 +1,27 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userId": "5931a75ae4bbd512288c680b", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { - "url": "http://contoso.com/delegation", - "validationKey": "", "subscriptions": { "enabled": true }, + "url": "http://contoso.com/delegation", "userRegistration": { "enabled": true - } + }, + "validationKey": "" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" }, "responses": { "204": {} - } + }, + "operationId": "DelegationSettings_Update", + "title": "ApiManagementPortalSettingsUpdateDelegation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsUpdateSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsUpdateSignIn.json index c79600bfe5d5..709f28e1dadb 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsUpdateSignIn.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsUpdateSignIn.json @@ -1,18 +1,20 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userId": "5931a75ae4bbd512288c680b", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "enabled": true } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" }, "responses": { "204": {} - } + }, + "operationId": "SignInSettings_Update", + "title": "ApiManagementPortalSettingsUpdateSignIn" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsUpdateSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsUpdateSignUp.json index 4d1050b4e22a..26f2a8458663 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsUpdateSignUp.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPortalSettingsUpdateSignUp.json @@ -1,23 +1,25 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userId": "5931a75ae4bbd512288c680b", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "enabled": true, "termsOfService": { + "consentRequired": true, "enabled": true, - "text": "Terms of service text.", - "consentRequired": true + "text": "Terms of service text." } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512288c680b" }, "responses": { "204": {} - } + }, + "operationId": "SignUpSettings_Update", + "title": "ApiManagementPortalSettingsUpdateSignUp" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPostAuthorizationConfirmConsentCodeRequest.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPostAuthorizationConfirmConsentCodeRequest.json index 62a8efeff875..0697deb1d555 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPostAuthorizationConfirmConsentCodeRequest.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementPostAuthorizationConfirmConsentCodeRequest.json @@ -1,16 +1,18 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "authorizationProviderId": "aadwithauthcode", "authorizationId": "authz1", + "authorizationProviderId": "aadwithauthcode", "parameters": { "consentCode": "theconsentcode" - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": {} - } + }, + "operationId": "Authorization_ConfirmConsentCode", + "title": "ApiManagementPostAuthorizationConfirmConsentCodeRequest" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshCertificate.json index c3a1edea8a82..9c9a97fa3740 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshCertificate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshCertificate.json @@ -1,31 +1,33 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "certificateId": "templateCertkv" + "certificateId": "templateCertkv", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", - "type": "Microsoft.ApiManagement/service/certificates", "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv", "properties": { - "subject": "CN=*.msitesting.net", - "thumbprint": "EA**********************9AD690", "expirationDate": "2037-01-01T07:00:00Z", "keyVault": { - "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-22T00:24:53.3191468Z" - } - } + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" } } } - } + }, + "operationId": "Certificate_RefreshSecret", + "title": "ApiManagementRefreshCertificate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshNamedValue.json index 185d20303d6b..c2677fbe6392 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshNamedValue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshNamedValue.json @@ -1,40 +1,42 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "namedValueId": "testprop2" + "namedValueId": "testprop2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6/refreshSecret?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", - "type": "Microsoft.ApiManagement/service/namedValues", "name": "testprop6", + "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6", "properties": { "displayName": "prop6namekv", "keyVault": { - "secretIdentifier": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-11T00:54:31.8024882Z" - } + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert" }, + "secret": true, "tags": [ "foo", "bar" - ], - "secret": true + ] } } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6/refreshSecret?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } } - } + }, + "operationId": "NamedValue_RefreshSecret", + "title": "ApiManagementRefreshNamedValue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshWorkspaceCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshWorkspaceCertificate.json index 93cceb586845..c97a4c6c5199 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshWorkspaceCertificate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshWorkspaceCertificate.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "certificateId": "templateCertkv", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "certificateId": "templateCertkv" + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", - "type": "Microsoft.ApiManagement/service/workspaces/certificates", "name": "templateCertkv", + "type": "Microsoft.ApiManagement/service/workspaces/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv", "properties": { - "subject": "CN=*.msitesting.net", - "thumbprint": "EA**********************9AD690", "expirationDate": "2037-01-01T07:00:00Z", "keyVault": { - "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert", "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-22T00:24:53.3191468Z" - } - } + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert" + }, + "subject": "CN=*.msitesting.net", + "thumbprint": "EA**********************9AD690" } } } - } + }, + "operationId": "WorkspaceCertificate_RefreshSecret", + "title": "ApiManagementRefreshWorkspaceCertificate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshWorkspaceNamedValue.json index 0f8333c080bf..c516f443cd1d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshWorkspaceNamedValue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRefreshWorkspaceNamedValue.json @@ -1,41 +1,43 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "namedValueId": "testprop2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "namedValueId": "testprop2" + "workspaceId": "wks1" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6/refreshSecret?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", - "type": "Microsoft.ApiManagement/service/workspaces/namedValues", "name": "testprop6", + "type": "Microsoft.ApiManagement/service/workspaces/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6", "properties": { "displayName": "prop6namekv", "keyVault": { - "secretIdentifier": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert", "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31", "lastStatus": { "code": "Success", "timeStampUtc": "2020-09-11T00:54:31.8024882Z" - } + }, + "secretIdentifier": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert" }, + "secret": true, "tags": [ "foo", "bar" - ], - "secret": true + ] } } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6/refreshSecret?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } } - } + }, + "operationId": "WorkspaceNamedValue_RefreshSecret", + "title": "ApiManagementRefreshWorkspaceNamedValue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRestoreWithAccessKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRestoreWithAccessKey.json index 99e3ddd11ebe..974f789dadec 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRestoreWithAccessKey.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementRestoreWithAccessKey.json @@ -1,138 +1,140 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { - "storageAccount": "teststorageaccount", - "containerName": "backupContainer", - "backupName": "apimService1backup_2017_03_19", + "accessKey": "**************************************************", "accessType": "AccessKey", - "accessKey": "**************************************************" - } + "backupName": "apimService1backup_2017_03_19", + "containerName": "backupContainer", + "storageAccount": "teststorageaccount" + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "tag1": "value1", - "tag2": "value2", - "tag3": "value3" - }, - "location": "West US", "etag": "AAAAAAACXok=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "West US", "properties": { - "publisherEmail": "apim@autorestsdk.com", - "publisherName": "autorestsdk", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", + "additionalLocations": [ + { + "disableGateway": true, + "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", + "location": "East US", + "publicIPAddresses": [ + "23.101.138.153" + ], + "sku": { + "name": "Premium", + "capacity": 1 + } + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-01-01" + }, "createdAtUtc": "2019-12-18T06:26:20.3348609Z", - "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", + "defaultSslBinding": false, "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": false + "negotiateClientCertificate": false }, { "type": "Proxy", - "hostName": "gateway1.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" }, - "defaultSslBinding": true + "defaultSslBinding": true, + "hostName": "gateway1.msitesting.net", + "negotiateClientCertificate": false }, { "type": "Management", - "hostName": "mgmt.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" }, - "defaultSslBinding": false + "defaultSslBinding": false, + "hostName": "mgmt.msitesting.net", + "negotiateClientCertificate": false }, { "type": "Portal", - "hostName": "portal1.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" }, - "defaultSslBinding": false + "defaultSslBinding": false, + "hostName": "portal1.msitesting.net", + "negotiateClientCertificate": false }, { "type": "ConfigurationApi", - "hostName": "config-api.msitesting.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2036-01-01T07:00:00+00:00", - "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2" }, - "defaultSslBinding": false + "defaultSslBinding": false, + "hostName": "config-api.msitesting.net", + "negotiateClientCertificate": false } ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", "publicIPAddresses": [ "13.91.32.113" ], - "additionalLocations": [ - { - "location": "East US", - "sku": { - "name": "Premium", - "capacity": 1 - }, - "publicIPAddresses": [ - "23.101.138.153" - ], - "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net", - "disableGateway": true - } - ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, - "apiVersionConstraint": { - "minApiVersion": "2019-01-01" - } + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 + }, + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" } } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" + } } - } + }, + "operationId": "ApiManagementService_Restore", + "title": "ApiManagementRestoreService" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceCheckNameAvailability.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceCheckNameAvailability.json index 4d2f0c9a7bda..eff793d34f0e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceCheckNameAvailability.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceCheckNameAvailability.json @@ -1,19 +1,21 @@ { "parameters": { - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { "name": "apimService1" - } + }, + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "message": "", "nameAvailable": true, - "reason": "Valid", - "message": "" + "reason": "Valid" } } - } + }, + "operationId": "ApiManagementService_CheckNameAvailability", + "title": "ApiManagementServiceCheckNameAvailability" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceDeleteService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceDeleteService.json index cee7d7b11012..970c088ca22b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceDeleteService.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceDeleteService.json @@ -1,60 +1,62 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { + "200": {}, "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2024-10-01-preview" - }, "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": {}, - "location": "West US", "etag": "AAAAAAFfhHY=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "West US", "properties": { - "publisherEmail": "contoso@live.com", - "publisherName": "Microsoft", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "Deleting", "createdAtUtc": "2016-12-20T19:41:21.5823069Z", - "gatewayUrl": "https://apimService1.azure-api.net", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True" + }, "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", "publicIPAddresses": [ "40.XX.XXX.168" ], + "publisherEmail": "contoso@live.com", + "publisherName": "Microsoft", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "Deleting", "virtualNetworkConfiguration": { "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/BlockVNETSamir/subnets/default" }, - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, "virtualNetworkType": "External" }, "sku": { "name": "Developer", "capacity": 1 - } + }, + "tags": {} + }, + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2024-10-01-preview" } }, - "204": {}, - "200": {} - } + "204": {} + }, + "operationId": "ApiManagementService_Delete", + "title": "ApiManagementServiceDeleteService" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetDomainOwnershipIdentifier.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetDomainOwnershipIdentifier.json index cf5522560c9e..885296543a26 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetDomainOwnershipIdentifier.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetDomainOwnershipIdentifier.json @@ -1,7 +1,7 @@ { "parameters": { - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -10,5 +10,7 @@ "domainOwnershipIdentifier": "KLE1vdMblVeHECAi4nCe3oNaXXXXvNlLrXt2ev84KM=" } } - } + }, + "operationId": "ApiManagementService_GetDomainOwnershipIdentifier", + "title": "ApiManagementServiceGetDomainOwnershipIdentifier" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetMultiRegionInternalVnet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetMultiRegionInternalVnet.json index cad79f04d774..471488800f2e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetMultiRegionInternalVnet.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetMultiRegionInternalVnet.json @@ -1,100 +1,102 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1", "name": "apimservice1", "type": "Microsoft.ApiManagement/service", - "tags": {}, - "location": "West US", "etag": "AAAAAADqC0c=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1", + "location": "West US", "properties": { - "publisherEmail": "abcs@contoso.com", - "publisherName": "contoso publisher", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", + "additionalLocations": [ + { + "disableGateway": false, + "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net", + "location": "West US 2", + "privateIPAddresses": [ + "10.0.X.6" + ], + "publicIPAddresses": [ + "40.XXX.79.187" + ], + "sku": { + "name": "Premium", + "capacity": 1 + }, + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub" + } + } + ], + "apiVersionConstraint": {}, "createdAtUtc": "2019-12-02T01:42:09.1268424Z", - "gatewayUrl": "https://apimservice1.azure-api.net", - "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net", - "portalUrl": "https://apimservice1.portal.azure-api.net", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True" + }, "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimservice1.management.azure-api.net", - "scmUrl": "https://apimservice1.scm.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net", + "gatewayUrl": "https://apimservice1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": false, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false }, { "type": "Proxy", - "hostName": "apimgatewaytest.preview.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2019-08-16T16:51:34+00:00", - "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476", - "subject": "CN=*.preview.net" + "subject": "CN=*.preview.net", + "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476" }, + "certificateSource": "Custom", "defaultSslBinding": true, - "certificateSource": "Custom" + "hostName": "apimgatewaytest.preview.net", + "negotiateClientCertificate": false } ], - "publicIPAddresses": [ - "137.XXX.11.74" - ], + "managementApiUrl": "https://apimservice1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimservice1.portal.azure-api.net", "privateIPAddresses": [ "172.XX.0.5" ], - "additionalLocations": [ - { - "location": "West US 2", - "sku": { - "name": "Premium", - "capacity": 1 - }, - "publicIPAddresses": [ - "40.XXX.79.187" - ], - "privateIPAddresses": [ - "10.0.X.6" - ], - "virtualNetworkConfiguration": { - "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub" - }, - "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net", - "disableGateway": false - } + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "137.XXX.11.74" ], + "publisherEmail": "abcs@contoso.com", + "publisherName": "contoso publisher", + "scmUrl": "https://apimservice1.scm.azure-api.net", + "targetProvisioningState": "", "virtualNetworkConfiguration": { "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet" }, - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False" - }, - "virtualNetworkType": "Internal", - "disableGateway": false, - "apiVersionConstraint": {} + "virtualNetworkType": "Internal" }, "sku": { "name": "Premium", "capacity": 1 - } + }, + "tags": {} } } - } + }, + "operationId": "ApiManagementService_Get", + "title": "ApiManagementServiceGetMultiRegionInternalVnet" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetNetworkStatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetNetworkStatus.json index cf93092851e2..5da2ccdc17ea 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetNetworkStatus.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetNetworkStatus.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -11,167 +11,169 @@ { "location": "Central US EUAP", "networkStatus": { - "dnsServers": [ - "168.63.129.16" - ], "connectivityStatus": [ { "name": "apimst8rlxXXXXX7.queue.core.windows.net", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:41:44.6399168Z", + "isOptional": true, "lastStatusChange": "2023-05-25T03:53:44.1786214Z", + "lastUpdated": "2023-06-08T16:41:44.6399168Z", "resourceType": "SmtpQueue", - "isOptional": true + "status": "success" }, { "name": "apimstm5lkXXXXX4kky0.blob.core.windows.net", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:39:33.9426753Z", + "isOptional": false, "lastStatusChange": "2023-05-25T03:53:44.1786214Z", + "lastUpdated": "2023-06-08T16:39:33.9426753Z", "resourceType": "BlobStorage", - "isOptional": false + "status": "success" }, { "name": "apimstm5lkXXXXX4kky0.file.core.windows.net", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:41:38.9993574Z", + "isOptional": true, "lastStatusChange": "2023-05-25T03:53:43.8953621Z", + "lastUpdated": "2023-06-08T16:41:38.9993574Z", "resourceType": "FileStorage", - "isOptional": true + "status": "success" }, { "name": "apimstm5lkXXXXX4kky0.queue.core.windows.net", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:41:38.4368875Z", + "isOptional": true, "lastStatusChange": "2023-05-25T03:53:44.2081238Z", + "lastUpdated": "2023-06-08T16:41:38.4368875Z", "resourceType": "Queue", - "isOptional": true + "status": "success" }, { "name": "apimstm5lkXXXXX4kky0.table.core.windows.net", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:41:17.4762359Z", + "isOptional": false, "lastStatusChange": "2023-05-25T03:53:43.9734877Z", + "lastUpdated": "2023-06-08T16:41:17.4762359Z", "resourceType": "TableStorage", - "isOptional": false + "status": "success" }, { "name": "apirpsqlmgsXXXXXXic45.database.windows.net", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:40:50.2954792Z", + "isOptional": false, "lastStatusChange": "2023-05-25T03:53:44.0704109Z", + "lastUpdated": "2023-06-08T16:40:50.2954792Z", "resourceType": "SQLDatabase", - "isOptional": false + "status": "success" }, { "name": "gcs.prod.monitoring.core.windows.net", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:40:09.8448385Z", + "isOptional": false, "lastStatusChange": "2023-05-25T03:53:43.8484895Z", + "lastUpdated": "2023-06-08T16:40:09.8448385Z", "resourceType": "Monitoring", - "isOptional": false + "status": "success" }, { "name": "https://apikv-XXXXXXurugl3.vault.azure.net", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:40:17.3447288Z", + "isOptional": false, "lastStatusChange": "2023-06-02T06:54:45.7125288Z", + "lastUpdated": "2023-06-08T16:40:17.3447288Z", "resourceType": "AzureKeyVault", - "isOptional": false + "status": "success" }, { "name": "https://centraluseuap.login.microsoft.com", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:40:01.6660359Z", + "isOptional": true, "lastStatusChange": "2023-05-25T03:53:44.1490292Z", + "lastUpdated": "2023-06-08T16:40:01.6660359Z", "resourceType": "RegionalAzureActiveDirectory", - "isOptional": true + "status": "success" }, { "name": "https://gcs.prod.warm.ingestion.monitoring.azure.com", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:42:08.0050056Z", + "isOptional": true, "lastStatusChange": "2023-05-26T14:09:26.2508948Z", + "lastUpdated": "2023-06-08T16:42:08.0050056Z", "resourceType": "Monitoring", - "isOptional": true + "status": "success" }, { "name": "https://global.prod.microsoftmetrics.com/", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:40:12.9698299Z", + "isOptional": true, "lastStatusChange": "2023-05-25T03:53:44.1297766Z", + "lastUpdated": "2023-06-08T16:40:12.9698299Z", "resourceType": "Monitoring", - "isOptional": true + "status": "success" }, { "name": "https://login.windows.net", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:40:43.4048644Z", + "isOptional": true, "lastStatusChange": "2023-06-04T11:10:16.1041673Z", + "lastUpdated": "2023-06-08T16:40:43.4048644Z", "resourceType": "AzureActiveDirectory", - "isOptional": true + "status": "success" }, { "name": "https://partner.prod.repmap.microsoft.com", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:40:32.6067213Z", + "isOptional": true, "lastStatusChange": "2023-05-25T03:53:44.2081238Z", + "lastUpdated": "2023-06-08T16:40:32.6067213Z", "resourceType": "CaptchaEndpoint", - "isOptional": true + "status": "success" }, { "name": "https://xxxxx.prod.microsoftmetrics.com:1886/RecoveryService", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:42:33.8566303Z", + "isOptional": true, "lastStatusChange": "2023-05-25T03:53:44.3488261Z", + "lastUpdated": "2023-06-08T16:42:33.8566303Z", "resourceType": "Metrics", - "isOptional": true + "status": "success" }, { "name": "https://samir-XXXXXXX.management.azure-api.net:3443/servicestatus?api-version=2018-01-01", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:42:10.3954682Z", + "isOptional": false, "lastStatusChange": "2023-06-08T16:42:10.3954682Z", + "lastUpdated": "2023-06-08T16:42:10.3954682Z", "resourceType": "ApiManagement Control Plane - inbound", - "isOptional": false + "status": "success" }, { "name": "LocalGatewayRedis", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:39:30.184537Z", + "isOptional": true, "lastStatusChange": "2023-05-25T03:53:44.2081238Z", + "lastUpdated": "2023-06-08T16:39:30.184537Z", "resourceType": "InternalCache", - "isOptional": true + "status": "success" }, { "name": "Scm", - "status": "success", "error": "", - "lastUpdated": "2023-06-08T16:41:24.6623693Z", + "isOptional": true, "lastStatusChange": "2023-05-25T03:32:02.6480516Z", + "lastUpdated": "2023-06-08T16:41:24.6623693Z", "resourceType": "SourceControl", - "isOptional": true + "status": "success" } + ], + "dnsServers": [ + "168.63.129.16" ] } } ] } - } + }, + "operationId": "NetworkStatus_ListByService", + "title": "ApiManagementServiceGetNetworkStatus" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetNetworkStatusByLocation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetNetworkStatusByLocation.json index ee6a4be7fd9c..52909268182d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetNetworkStatusByLocation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetNetworkStatusByLocation.json @@ -1,146 +1,148 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "locationName": "North Central US" + "locationName": "North Central US", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "dnsServers": [ - "10.82.98.10" - ], "connectivityStatus": [ { "name": "apimgmtst6tnxxxxxxxxxxx.blob.core.windows.net", - "status": "success", "error": "", - "lastUpdated": "2020-11-24T22:55:14.7035899Z", + "isOptional": false, "lastStatusChange": "2020-11-20T07:54:55.9365931Z", + "lastUpdated": "2020-11-24T22:55:14.7035899Z", "resourceType": "BlobStorage", - "isOptional": false + "status": "success" }, { "name": "apimgmtst6tnxxxxxxxxxxx.file.core.windows.net", - "status": "success", "error": "", - "lastUpdated": "2020-11-24T22:55:41.5322463Z", + "isOptional": true, "lastStatusChange": "2020-11-20T07:54:55.9265938Z", + "lastUpdated": "2020-11-24T22:55:41.5322463Z", "resourceType": "FileStorage", - "isOptional": true + "status": "success" }, { "name": "apimgmtst6tnxxxxxxxxxxx.queue.core.windows.net", - "status": "success", "error": "", - "lastUpdated": "2020-11-24T22:55:30.645994Z", + "isOptional": true, "lastStatusChange": "2020-11-20T07:54:55.8410477Z", + "lastUpdated": "2020-11-24T22:55:30.645994Z", "resourceType": "Queue", - "isOptional": true + "status": "success" }, { "name": "apimgmtst6tnxxxxxxxxxxx.table.core.windows.net", - "status": "success", "error": "", - "lastUpdated": "2020-11-24T22:55:23.8789171Z", + "isOptional": false, "lastStatusChange": "2020-11-20T07:54:55.9365931Z", + "lastUpdated": "2020-11-24T22:55:23.8789171Z", "resourceType": "TableStorage", - "isOptional": false + "status": "success" }, { "name": "gcs.prod.monitoring.core.windows.net", - "status": "success", "error": "", - "lastUpdated": "2020-11-24T22:57:34.8666833Z", + "isOptional": true, "lastStatusChange": "2020-11-20T08:07:37.5486932Z", + "lastUpdated": "2020-11-24T22:57:34.8666833Z", "resourceType": "Monitoring", - "isOptional": true + "status": "success" }, { "name": "https://gcs.ppe.warm.ingestion.monitoring.azure.com", - "status": "success", "error": "", - "lastUpdated": "2020-11-24T22:56:26.1870188Z", + "isOptional": true, "lastStatusChange": "2020-11-20T07:54:56.1060523Z", + "lastUpdated": "2020-11-24T22:56:26.1870188Z", "resourceType": "Monitoring", - "isOptional": true + "status": "success" }, { "name": "https://global.metrics.nsatc.net/", - "status": "success", "error": "", - "lastUpdated": "2020-11-24T22:56:35.9620612Z", + "isOptional": true, "lastStatusChange": "2020-11-20T07:54:56.0510519Z", + "lastUpdated": "2020-11-24T22:56:35.9620612Z", "resourceType": "Monitoring", - "isOptional": true + "status": "success" }, { "name": "https://login.windows.net", - "status": "success", "error": "", - "lastUpdated": "2020-11-24T22:56:30.8047708Z", + "isOptional": true, "lastStatusChange": "2020-11-20T07:54:56.1060523Z", + "lastUpdated": "2020-11-24T22:56:30.8047708Z", "resourceType": "AzureActiveDirectory", - "isOptional": true + "status": "success" }, { "name": "https://prod2.metrics.nsatc.net:1886/RecoveryService", - "status": "success", "error": "", - "lastUpdated": "2020-11-24T22:56:45.2095302Z", + "isOptional": true, "lastStatusChange": "2020-11-20T07:54:56.2796235Z", + "lastUpdated": "2020-11-24T22:56:45.2095302Z", "resourceType": "Metrics", - "isOptional": true + "status": "success" }, { "name": "LocalGatewayRedis", - "status": "success", "error": "", - "lastUpdated": "2020-11-24T22:55:15.1345836Z", + "isOptional": true, "lastStatusChange": "2020-11-20T07:54:55.9365931Z", + "lastUpdated": "2020-11-24T22:55:15.1345836Z", "resourceType": "InternalCache", - "isOptional": true + "status": "success" }, { "name": "prod.warmpath.msftcloudes.com", - "status": "success", "error": "", - "lastUpdated": "2020-11-24T22:55:57.8992141Z", + "isOptional": false, "lastStatusChange": "2020-11-20T07:54:55.8410477Z", + "lastUpdated": "2020-11-24T22:55:57.8992141Z", "resourceType": "Monitoring", - "isOptional": false + "status": "success" }, { "name": "Scm", - "status": "success", "error": "", - "lastUpdated": "2020-11-24T23:03:57.6187917Z", + "isOptional": true, "lastStatusChange": "2020-11-20T07:54:57.325384Z", + "lastUpdated": "2020-11-24T23:03:57.6187917Z", "resourceType": "SourceControl", - "isOptional": true + "status": "success" }, { "name": "smtpi-xxx.msn.com:25028", - "status": "success", "error": "", - "lastUpdated": "2020-11-24T22:58:22.2430074Z", + "isOptional": true, "lastStatusChange": "2020-11-20T07:54:56.3510577Z", + "lastUpdated": "2020-11-24T22:58:22.2430074Z", "resourceType": "Email", - "isOptional": true + "status": "success" }, { "name": "zwcvuxxxx.database.windows.net", - "status": "success", "error": "", - "lastUpdated": "2020-11-24T22:55:44.3582171Z", + "isOptional": false, "lastStatusChange": "2020-11-20T07:54:56.0410467Z", + "lastUpdated": "2020-11-24T22:55:44.3582171Z", "resourceType": "SQLDatabase", - "isOptional": false + "status": "success" } + ], + "dnsServers": [ + "10.82.98.10" ] } } - } + }, + "operationId": "NetworkStatus_ListByLocation", + "title": "ApiManagementServiceGetNetworkStatusByLocation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json index 553dc75b7a22..628c18068877 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -459,5 +459,7 @@ ] } } - } + }, + "operationId": "OutboundNetworkDependenciesEndpoints_ListByService", + "title": "ApiManagementServiceGetOutboundNetworkDependenciesEndpoints" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetService.json index 411a1ab61f5e..fb765b66b1f0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetService.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetService.json @@ -1,179 +1,181 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium", "name": "OGF-Z3-06162021-Premium", "type": "Microsoft.ApiManagement/service", - "tags": { - "owner": "v-aswmoh", - "ReleaseName": "Z3" + "etag": "AAAAAAAWN/4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { + "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789", + "principalId": "713784d2-ee37-412a-95f0-3768f397f82d" + } + } }, "location": "East US", - "etag": "AAAAAAAWN/4=", "properties": { - "publisherEmail": "string", - "publisherName": "Test Premium", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", + "additionalLocations": [ + { + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net", + "location": "East US 2", + "platformVersion": "stv2", + "publicIPAddresses": [ + "40.70.24.106" + ], + "sku": { + "name": "Premium", + "capacity": 1 + }, + "zones": [] + } + ], + "apiVersionConstraint": { + "minApiVersion": "2019-12-01" + }, + "certificates": [], "createdAtUtc": "2021-06-16T09:40:00.9453556Z", - "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net", - "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net", - "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false" + }, "developerPortalUrl": "https://ogf-z3-06162021-premium.developer.azure-api.net", - "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net", - "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net", + "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "ogf-z3-06162021-premium.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": false, - "certificateSource": "BuiltIn" + "hostName": "ogf-z3-06162021-premium.azure-api.net", + "negotiateClientCertificate": false }, { "type": "Proxy", - "hostName": "gateway.current.int-azure-api.net", - "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", - "negotiateClientCertificate": true, "certificate": { "expiry": "2022-01-08T22:32:32+00:00", - "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51", - "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51" }, + "certificateSource": "Custom", "defaultSslBinding": true, - "certificateSource": "Custom" + "hostName": "gateway.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", + "negotiateClientCertificate": true }, { "type": "DeveloperPortal", - "hostName": "developer.current.int-azure-api.net", - "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", - "negotiateClientCertificate": false, "certificate": { "expiry": "2022-01-08T22:32:32+00:00", - "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51", - "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51" }, + "certificateSource": "Custom", "defaultSslBinding": false, - "certificateSource": "Custom" + "hostName": "developer.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", + "negotiateClientCertificate": false }, { "type": "Management", - "hostName": "mgmt.current.int-azure-api.net", - "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", - "negotiateClientCertificate": false, "certificate": { "expiry": "2022-01-08T22:32:32+00:00", - "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51", - "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51" }, + "certificateSource": "Custom", "defaultSslBinding": false, - "certificateSource": "Custom" + "hostName": "mgmt.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", + "negotiateClientCertificate": false }, { "type": "ConfigurationApi", - "hostName": "configuration-api.current.int-azure-api.net", - "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", - "negotiateClientCertificate": false, "certificate": { "expiry": "2022-01-08T22:32:32+00:00", - "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51", - "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US" + "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US", + "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51" }, + "certificateSource": "Custom", "defaultSslBinding": false, - "certificateSource": "Custom" - } - ], - "publicIPAddresses": [ - "13.92.130.49" - ], - "additionalLocations": [ - { - "location": "East US 2", - "sku": { - "name": "Premium", - "capacity": 1 - }, - "zones": [], - "publicIPAddresses": [ - "40.70.24.106" - ], - "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net", - "disableGateway": false, - "platformVersion": "stv2" + "hostName": "configuration-api.current.int-azure-api.net", + "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl", + "negotiateClientCertificate": false } ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false" - }, - "virtualNetworkType": "None", - "certificates": [], - "disableGateway": false, - "apiVersionConstraint": { - "minApiVersion": "2019-12-01" - }, - "publicNetworkAccess": "Enabled", + "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net", "privateEndpointConnections": [ { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName", - "type": "Microsoft.ApiManagement/service/privateEndpointConnections", "name": "privateEndpointProxyName", + "type": "Microsoft.ApiManagement/service/privateEndpointConnections", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName", "properties": { - "provisioningState": "Pending", + "groupIds": [ + "Gateway" + ], "privateEndpoint": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName" }, "privateLinkServiceConnectionState": { - "status": "Pending", "description": "Please approve my request, thanks", - "actionsRequired": "None" + "actionsRequired": "None", + "status": "Pending" }, - "groupIds": [ - "Gateway" - ] + "provisioningState": "Pending" } } ], - "platformVersion": "stv2" + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "13.92.130.49" + ], + "publicNetworkAccess": "Enabled", + "publisherEmail": "string", + "publisherName": "Test Premium", + "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Premium", "capacity": 1 }, - "identity": { - "type": "SystemAssigned, UserAssigned", - "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e", - "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", - "userAssignedIdentities": { - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": { - "principalId": "713784d2-ee37-412a-95f0-3768f397f82d", - "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789" - } - } - }, "systemData": { + "createdAt": "2021-06-16T09:40:00.7106733Z", "createdBy": "string", "createdByType": "User", - "createdAt": "2021-06-16T09:40:00.7106733Z", + "lastModifiedAt": "2021-06-20T06:33:09.6159006Z", "lastModifiedBy": "foo@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2021-06-20T06:33:09.6159006Z" + "lastModifiedByType": "User" + }, + "tags": { + "ReleaseName": "Z3", + "owner": "v-aswmoh" } } } - } + }, + "operationId": "ApiManagementService_Get", + "title": "ApiManagementServiceGetService" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetServiceHavingMsi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetServiceHavingMsi.json index dd1be805b8cf..24079e30f486 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetServiceHavingMsi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetServiceHavingMsi.json @@ -1,89 +1,91 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": {}, - "location": "West Europe", "etag": "AAAAAAAENfI=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "ca1d33f7-0000-42ec-0000-d526a1ee953a", + "tenantId": "72f988bf-0000-41af-0000-2d7cd011db47", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": { + "clientId": "aaff9c7d-0000-4db2-0000-ab0e3e7806cf", + "principalId": "95194df2-9208-0000-0000-a10d2af9b5a3" + } + } + }, + "location": "West Europe", "properties": { - "publisherEmail": "foo@contoso.com", - "publisherName": "Contoso", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", "createdAtUtc": "2016-04-12T00:20:15.6018952Z", - "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True" + }, "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": false, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false }, { "type": "Proxy", - "hostName": "proxy.msitesting.net", - "keyVaultId": "https://samir-msi-keyvault.vault.azure.net/secrets/msicertificate", - "negotiateClientCertificate": false, "certificate": { "expiry": "2020-12-18T11:11:47+00:00", - "thumbprint": "9833D531D7A45XXXXXA85908BD3692E0BD3F", - "subject": "CN=*.msitesting.net" + "subject": "CN=*.msitesting.net", + "thumbprint": "9833D531D7A45XXXXXA85908BD3692E0BD3F" }, + "certificateSource": "KeyVault", "defaultSslBinding": true, - "certificateSource": "KeyVault" + "hostName": "proxy.msitesting.net", + "keyVaultId": "https://samir-msi-keyvault.vault.azure.net/secrets/msicertificate", + "negotiateClientCertificate": false } ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", "publicIPAddresses": [ "13.94.xxx.188" ], + "publisherEmail": "foo@contoso.com", + "publisherName": "Contoso", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", "virtualNetworkConfiguration": { "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet" }, - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "External", - "disableGateway": false + "virtualNetworkType": "External" }, "sku": { "name": "Premium", "capacity": 1 }, - "identity": { - "type": "SystemAssigned, UserAssigned", - "principalId": "ca1d33f7-0000-42ec-0000-d526a1ee953a", - "tenantId": "72f988bf-0000-41af-0000-2d7cd011db47", - "userAssignedIdentities": { - "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": { - "principalId": "95194df2-9208-0000-0000-a10d2af9b5a3", - "clientId": "aaff9c7d-0000-4db2-0000-ab0e3e7806cf" - } - } - } + "tags": {} } } - } + }, + "operationId": "ApiManagementService_Get", + "title": "ApiManagementServiceGetServiceHavingMsi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetSsoToken.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetSsoToken.json index 9c8d82057399..fa54afac75c7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetSsoToken.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceGetSsoToken.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -11,5 +11,7 @@ "redirectUri": "https://apimService1.portal.azure-api.net:443/signin-sso?token=1%26201705301929%26eIkr3%2fnfaLs1GVJ0OVbzkJjAcwPFkEZAPM8VUXvXPf7cJ6lWsB9oUwsk2zln9x0KLkn21txCPJWWheSPq7SNeA%3d%3d" } } - } + }, + "operationId": "ApiManagementService_GetSsoToken", + "title": "ApiManagementServiceGetSsoToken" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceMigrateToStv2.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceMigrateToStv2.json index 29ede0ad858b..9a251cbff63c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceMigrateToStv2.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementServiceMigrateToStv2.json @@ -1,109 +1,111 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { "mode": "PreserveIp" - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1", "name": "apimservice1", "type": "Microsoft.ApiManagement/service", - "tags": {}, - "location": "West US", "etag": "AAAAAADqC0c=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1", + "location": "West US", "properties": { - "publisherEmail": "abcs@contoso.com", - "publisherName": "contoso publisher", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", + "additionalLocations": [ + { + "disableGateway": false, + "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net", + "location": "West US 2", + "privateIPAddresses": [ + "10.0.X.6" + ], + "publicIPAddresses": [ + "40.XXX.79.187" + ], + "sku": { + "name": "Premium", + "capacity": 1 + }, + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub" + } + } + ], + "apiVersionConstraint": {}, "createdAtUtc": "2019-12-02T01:42:09.1268424Z", - "gatewayUrl": "https://apimservice1.azure-api.net", - "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net", - "portalUrl": "https://apimservice1.portal.azure-api.net", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True" + }, "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimservice1.management.azure-api.net", - "scmUrl": "https://apimservice1.scm.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net", + "gatewayUrl": "https://apimservice1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, + "certificateSource": "BuiltIn", "defaultSslBinding": false, - "certificateSource": "BuiltIn" + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false }, { "type": "Proxy", - "hostName": "apimgatewaytest.preview.net", - "negotiateClientCertificate": false, "certificate": { "expiry": "2019-08-16T16:51:34+00:00", - "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476", - "subject": "CN=*.preview.net" + "subject": "CN=*.preview.net", + "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476" }, + "certificateSource": "Custom", "defaultSslBinding": true, - "certificateSource": "Custom" + "hostName": "apimgatewaytest.preview.net", + "negotiateClientCertificate": false } ], - "publicIPAddresses": [ - "137.XXX.11.74" - ], + "managementApiUrl": "https://apimservice1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "portalUrl": "https://apimservice1.portal.azure-api.net", "privateIPAddresses": [ "172.XX.0.5" ], - "additionalLocations": [ - { - "location": "West US 2", - "sku": { - "name": "Premium", - "capacity": 1 - }, - "publicIPAddresses": [ - "40.XXX.79.187" - ], - "privateIPAddresses": [ - "10.0.X.6" - ], - "virtualNetworkConfiguration": { - "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub" - }, - "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net", - "disableGateway": false - } + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "137.XXX.11.74" ], + "publisherEmail": "abcs@contoso.com", + "publisherName": "contoso publisher", + "scmUrl": "https://apimservice1.scm.azure-api.net", + "targetProvisioningState": "", "virtualNetworkConfiguration": { "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet" }, - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False" - }, - "virtualNetworkType": "Internal", - "disableGateway": false, - "apiVersionConstraint": {}, - "platformVersion": "stv2" + "virtualNetworkType": "Internal" }, "sku": { "name": "Premium", "capacity": 1 - } + }, + "tags": {} + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-10-01-preview" } } - } + }, + "operationId": "ApiManagementService_MigrateToStv2", + "title": "ApiManagementMigrateService" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementSubscriptionListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementSubscriptionListSecrets.json index ae2dc6720044..44ae70b5fbe3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementSubscriptionListSecrets.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementSubscriptionListSecrets.json @@ -1,10 +1,10 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "sid": "5931a769d8d14f0ad8ce13b8" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "5931a769d8d14f0ad8ce13b8", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -13,5 +13,7 @@ "secondaryKey": "" } } - } + }, + "operationId": "Subscription_ListSecrets", + "title": "ApiManagementSubscriptionListSecrets" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementSubscriptionRegeneratePrimaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementSubscriptionRegeneratePrimaryKey.json index 634222e7e13f..6002ad53882e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementSubscriptionRegeneratePrimaryKey.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementSubscriptionRegeneratePrimaryKey.json @@ -1,12 +1,14 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "sid": "testsub" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "204": {} - } + }, + "operationId": "Subscription_RegeneratePrimaryKey", + "title": "ApiManagementSubscriptionRegeneratePrimaryKey" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementSubscriptionRegenerateSecondaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementSubscriptionRegenerateSecondaryKey.json index 634222e7e13f..0c7fad53c6bd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementSubscriptionRegenerateSecondaryKey.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementSubscriptionRegenerateSecondaryKey.json @@ -1,12 +1,14 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "sid": "testsub" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "204": {} - } + }, + "operationId": "Subscription_RegenerateSecondaryKey", + "title": "ApiManagementSubscriptionRegenerateSecondaryKey" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessGitRegenerateSecondaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessGitRegenerateSecondaryKey.json new file mode 100644 index 000000000000..2b29b649cc70 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessGitRegenerateSecondaryKey.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accessName": "access", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + }, + "operationId": "TenantAccessGit_RegenerateSecondaryKey", + "title": "ApiManagementTenantAccessRegenerateKey" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessRegenerateKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessRegenerateKey.json index ff4e8c3bdf10..385ac71e37f8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessRegenerateKey.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessRegenerateKey.json @@ -1,12 +1,14 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "accessName": "access", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "accessName": "access" + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "204": {} - } + }, + "operationId": "TenantAccess_RegenerateSecondaryKey", + "title": "ApiManagementTenantAccessRegenerateKey" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessRegeneratePrimaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessRegeneratePrimaryKey.json new file mode 100644 index 000000000000..7c4c6a5964bd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessRegeneratePrimaryKey.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accessName": "access", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + }, + "operationId": "TenantAccess_RegeneratePrimaryKey", + "title": "ApiManagementTenantAccessRegenerateKey" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessRegenerateSecondaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessRegenerateSecondaryKey.json new file mode 100644 index 000000000000..32ad02923bd5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessRegenerateSecondaryKey.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accessName": "access", + "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + }, + "operationId": "TenantAccessGit_RegeneratePrimaryKey", + "title": "ApiManagementTenantAccessRegenerateKey" +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessSyncState.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessSyncState.json index dde7ddab4d7f..072fa158cef7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessSyncState.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantAccessSyncState.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "configurationName": "configuration" + "configurationName": "configuration", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/syncState", - "type": "Microsoft.ApiManagement/service/tenant/syncState", "name": "syncState", + "type": "Microsoft.ApiManagement/service/tenant/syncState", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/tenant/configuration", "properties": { "branch": "master", "commitId": "de891c2342c7058dde45e5e624eae7e558c94683", + "configurationChangeDate": "2021-04-13T00:11:43.862781Z", "isExport": true, - "isSynced": true, "isGitEnabled": true, - "syncDate": "2021-04-13T01:15:53.9824995Z", - "configurationChangeDate": "2021-04-13T00:11:43.862781Z", - "lastOperationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/operationResults/6074f0bd093a9d0dac3d7347" + "isSynced": true, + "lastOperationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/operationResults/6074f0bd093a9d0dac3d7347", + "syncDate": "2021-04-13T01:15:53.9824995Z" } } } - } + }, + "operationId": "TenantConfiguration_GetSyncState", + "title": "ApiManagementTenantAccessSyncState" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantConfigurationDeploy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantConfigurationDeploy.json index ad45777cc24a..79df9163579d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantConfigurationDeploy.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantConfigurationDeploy.json @@ -1,37 +1,39 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "configurationName": "configuration", "parameters": { "properties": { "branch": "master" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af4ae2a6d2e0b688d7517?api-version=2024-10-01-preview" - } - }, "200": { "body": { - "id": "6074e652093a9d0dac3d733c", - "type": "Microsoft.ApiManagement/service/tenant/operationResults", "name": "6074e652093a9d0dac3d733c", + "type": "Microsoft.ApiManagement/service/tenant/operationResults", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/tenant/configuration", "properties": { - "status": "Failed", - "started": "2017-11-26T17:06:54.303Z", - "updated": "2017-11-26T17:07:21.777Z", "error": { "code": "ValidationError", "message": "File not found: 'api-management/configuration.json'" - } + }, + "started": "2017-11-26T17:06:54.303Z", + "status": "Failed", + "updated": "2017-11-26T17:07:21.777Z" } } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af4ae2a6d2e0b688d7517?api-version=2024-10-01-preview" + } } - } + }, + "operationId": "TenantConfiguration_Deploy", + "title": "ApiManagementTenantConfigurationDeploy" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantConfigurationSave.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantConfigurationSave.json index 5e27e1371027..361cfc441a9d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantConfigurationSave.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantConfigurationSave.json @@ -1,35 +1,37 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "configurationName": "configuration", "parameters": { "properties": { "branch": "master" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af57d2a6d2e0b688d751b?api-version=2024-10-01-preview" - } - }, "200": { "body": { - "id": "6074e652093a9d0dac3d733c", - "type": "Microsoft.ApiManagement/service/tenant/operationResults", "name": "6074e652093a9d0dac3d733c", + "type": "Microsoft.ApiManagement/service/tenant/operationResults", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/tenant/configuration", "properties": { - "status": "Succeeded", - "started": "2021-04-13T00:31:14.94Z", - "updated": "2021-04-13T00:31:27.59Z", + "actionLog": [], "resultInfo": "The configuration was successfully saved to master as commit c0ae274f6046912107bad734834cbf65918668b6.", - "actionLog": [] + "started": "2021-04-13T00:31:14.94Z", + "status": "Succeeded", + "updated": "2021-04-13T00:31:27.59Z" } } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af57d2a6d2e0b688d751b?api-version=2024-10-01-preview" + } } - } + }, + "operationId": "TenantConfiguration_Save", + "title": "ApiManagementTenantConfigurationSave" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantConfigurationValidate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantConfigurationValidate.json index ce3296183a35..40be25596c21 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantConfigurationValidate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementTenantConfigurationValidate.json @@ -1,35 +1,37 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "configurationName": "configuration", "parameters": { "properties": { "branch": "master" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af64e2a6d2e0b688d751e?api-version=2024-10-01-preview" - } - }, "200": { "body": { - "id": "6074ec02093a9d0dac3d7345", - "type": "Microsoft.ApiManagement/service/tenant/operationResults", "name": "6074ec02093a9d0dac3d7345", + "type": "Microsoft.ApiManagement/service/tenant/operationResults", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1/tenant/configuration", "properties": { - "status": "Succeeded", - "started": "2021-04-13T00:55:30.62Z", - "updated": "2021-04-13T00:55:39.857Z", + "actionLog": [], "resultInfo": "Validation is successfull", - "actionLog": [] + "started": "2021-04-13T00:55:30.62Z", + "status": "Succeeded", + "updated": "2021-04-13T00:55:39.857Z" } } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af64e2a6d2e0b688d751e?api-version=2024-10-01-preview" + } } - } + }, + "operationId": "TenantConfiguration_Validate", + "title": "ApiManagementTenantConfigurationValidate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUndelete.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUndelete.json index e2ab91113c3f..65d389ba9dc7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUndelete.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUndelete.json @@ -1,10 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { + "location": "South Central US", "properties": { "publisherEmail": "foo@contoso.com", "publisherName": "foo", @@ -13,40 +11,57 @@ "sku": { "name": "Developer", "capacity": 1 - }, - "location": "South Central US" - } + } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "201": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - }, + "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAp3T4=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "South Central US", - "etag": "AAAAAAAp3P0=", "properties": { - "publisherEmail": "foo@contoso.com", - "publisherName": "foo", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Created", - "targetProvisioningState": "Activating", + "apiVersionConstraint": {}, "createdAtUtc": "2019-12-18T06:10:56.0327105Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False" + }, + "developerPortalUrl": "https://apimService1.developer.azure-api.net", + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-southcentralus-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", "hostnameConfigurations": [ { "type": "Proxy", + "defaultSslBinding": true, "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": true + "negotiateClientCertificate": false } ], - "virtualNetworkType": "None", - "disableGateway": false, - "apiVersionConstraint": {} + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "23.102.171.124" + ], + "publisherEmail": "foo@contoso.com", + "publisherName": "foo", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkType": "None" }, "sku": { "name": "Developer", @@ -54,56 +69,43 @@ } } }, - "200": { + "201": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", + "etag": "AAAAAAAp3P0=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "location": "South Central US", - "etag": "AAAAAAAp3T4=", "properties": { - "publisherEmail": "foo@contoso.com", - "publisherName": "foo", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", + "apiVersionConstraint": {}, "createdAtUtc": "2019-12-18T06:10:56.0327105Z", - "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-southcentralus-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", + "disableGateway": false, "hostnameConfigurations": [ { "type": "Proxy", + "defaultSslBinding": true, "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": true + "negotiateClientCertificate": false } ], - "publicIPAddresses": [ - "23.102.171.124" - ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False" - }, - "virtualNetworkType": "None", - "disableGateway": false, - "apiVersionConstraint": {} + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "publisherEmail": "foo@contoso.com", + "publisherName": "foo", + "targetProvisioningState": "Activating", + "virtualNetworkType": "None" }, "sku": { "name": "Developer", "capacity": 1 } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiManagementService_CreateOrUpdate", + "title": "ApiManagementUndelete" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApi.json index c7e4265f0bae..506589d23367 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApi.json @@ -1,41 +1,43 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "echo-api", - "If-Match": "*", "parameters": { "properties": { + "path": "newecho", "displayName": "Echo API New", - "serviceUrl": "http://echoapi.cloudapp.net/api2", - "path": "newecho" + "serviceUrl": "http://echoapi.cloudapp.net/api2" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", - "type": "Microsoft.ApiManagement/service/apis", "name": "echo-api", + "type": "Microsoft.ApiManagement/service/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", "properties": { - "displayName": "Echo API New", - "apiRevision": "1", - "serviceUrl": "http://echoapi.cloudapp.net/api2", "path": "newecho", + "apiRevision": "1", + "displayName": "Echo API New", + "isCurrent": true, + "isOnline": true, "protocols": [ "https" ], + "serviceUrl": "http://echoapi.cloudapp.net/api2", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "isOnline": true + } } } } - } + }, + "operationId": "Api_Update", + "title": "ApiManagementUpdateApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiDiagnostic.json index 665ad01487cf..11b3a39fd7fc 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiDiagnostic.json @@ -1,104 +1,106 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "diagnosticId": "applicationinsights", "apiId": "echo-api", - "If-Match": "*", + "diagnosticId": "applicationinsights", "parameters": { "properties": { "alwaysLog": "allErrors", - "loggerId": "/loggers/applicationinsights", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/apis/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "httpCorrelationProtocol": "Legacy", - "logClientIp": true, - "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", - "sampling": { - "samplingType": "fixed", - "percentage": 100 - }, - "frontend": { - "request": { - "headers": [], + "backend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } }, - "backend": { - "request": { - "headers": [], + "frontend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" } } } } - } + }, + "operationId": "ApiDiagnostic_Update", + "title": "ApiManagementUpdateApiDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiIssue.json index b684e584301a..0a8e5637c3dd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiIssue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiIssue.json @@ -1,33 +1,35 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "issueId": "57d2ef278aa04f0ad01d6cdc", "apiId": "57d1f7558aa04f15146d9d8a", - "If-Match": "*", + "issueId": "57d2ef278aa04f0ad01d6cdc", "parameters": { "properties": { "state": "closed" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/apis/issues", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", "properties": { - "title": "New API issue", "description": "New API issue description", + "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", "createdDate": "2018-02-01T22:21:20.467Z", "state": "open", - "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", - "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a" + "title": "New API issue", + "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" } } } - } + }, + "operationId": "ApiIssue_Update", + "title": "ApiManagementUpdateApiIssue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiOperation.json index 256ab427cd23..04dfbc886381 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiOperation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiOperation.json @@ -1,24 +1,21 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "apiId": "echo-api", "operationId": "operationId", "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", "parameters": { "properties": { - "displayName": "Retrieve resource", "method": "GET", - "urlTemplate": "/resource", + "displayName": "Retrieve resource", "templateParameters": [], + "urlTemplate": "/resource", "request": { "queryParameters": [ { "name": "param1", - "description": "A sample parameter that is required and has a default value of \"sample\".", "type": "string", + "description": "A sample parameter that is required and has a default value of \"sample\".", "defaultValue": "sample", "required": true, "values": [ @@ -29,36 +26,39 @@ }, "responses": [ { - "statusCode": 200, "description": "Returned in all cases.", + "headers": [], "representations": [], - "headers": [] + "statusCode": 200 }, { - "statusCode": 500, "description": "Server Error.", + "headers": [], "representations": [], - "headers": [] + "statusCode": 500 } ] } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/apis/operations", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", "properties": { - "displayName": "CancelOrder", "method": "POST", - "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", + "displayName": "CancelOrder", "templateParameters": [], + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", "request": { "description": "IFazioService_CancelOrder_InputMessage", - "queryParameters": [], "headers": [], + "queryParameters": [], "representations": [ { "contentType": "text/xml", @@ -69,8 +69,8 @@ }, "responses": [ { - "statusCode": 200, "description": "IFazioService_CancelOrder_OutputMessage", + "headers": [], "representations": [ { "contentType": "text/xml", @@ -78,11 +78,13 @@ "typeName": "CancelOrderResponse" } ], - "headers": [] + "statusCode": 200 } ] } } } - } + }, + "operationId": "ApiOperation_Update", + "title": "ApiManagementUpdateApiOperation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiRelease.json index 53f61662be78..21a3a39ffffd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiRelease.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiRelease.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "a1", - "releaseId": "testrev", - "If-Match": "*", "parameters": { "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", "notes": "yahooagain" } - } + }, + "releaseId": "testrev", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev", - "type": "Microsoft.ApiManagement/service/apis/releases", "name": "testrev", + "type": "Microsoft.ApiManagement/service/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", "createdDateTime": "2018-02-08T20:38:29.173Z", - "updatedDateTime": "2018-02-08T20:38:29.173Z", - "notes": "yahoo" + "notes": "yahoo", + "updatedDateTime": "2018-02-08T20:38:29.173Z" } } } - } + }, + "operationId": "ApiRelease_Update", + "title": "ApiManagementUpdateApiRelease" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiVersionSet.json index 8e8c68e6e4ad..4558bf196f7b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiVersionSet.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiVersionSet.json @@ -1,31 +1,33 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "versionSetId": "vs1", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { + "description": "Version configuration", "displayName": "api set 1", - "versioningScheme": "Segment", - "description": "Version configuration" + "versioningScheme": "Segment" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "vs1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1", - "type": "Microsoft.ApiManagement/service/api-version-sets", "name": "vs1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1", "properties": { + "description": "Version configuration", "displayName": "api set 1", - "versioningScheme": "Segment", - "description": "Version configuration" + "versioningScheme": "Segment" } } } - } + }, + "operationId": "ApiVersionSet_Update", + "title": "ApiManagementUpdateApiVersionSet" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiWiki.json index 65d640ef1837..6f69a777b955 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiWiki.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateApiWiki.json @@ -1,11 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "57d1f7558aa04f15146d9d8a", - "If-Match": "*", "parameters": { "properties": { "documents": [ @@ -14,14 +11,17 @@ } ] } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", - "type": "Microsoft.ApiManagement/service/apis/wikis", "name": "default", + "type": "Microsoft.ApiManagement/service/apis/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default", "properties": { "documents": [ { @@ -31,5 +31,7 @@ } } } - } + }, + "operationId": "ApiWiki_Update", + "title": "ApiManagementUpdateApiWiki" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateAuthorizationServer.json index ec4dbef748c6..8ed21a7755cb 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateAuthorizationServer.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateAuthorizationServer.json @@ -1,54 +1,56 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "authsid": "newauthServer", - "If-Match": "*", "parameters": { "properties": { "clientId": "update", "clientSecret": "updated", - "useInTestConsole": false, - "useInApiDocumentation": true + "useInApiDocumentation": true, + "useInTestConsole": false } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", - "type": "Microsoft.ApiManagement/service/authorizationServers", "name": "newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", "properties": { - "displayName": "test3", - "useInTestConsole": false, - "useInApiDocumentation": true, "description": "test server", - "clientRegistrationEndpoint": "https://www.contoso.com/apps", "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", "authorizationMethods": [ "GET" ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], "clientAuthenticationMethod": [ "Basic" ], - "tokenEndpoint": "https://www.contoso.com/oauth2/token", - "supportState": true, + "clientId": "updated", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", "defaultScope": "read write", + "displayName": "test3", "grantTypes": [ "authorizationCode", "implicit" ], - "bearerTokenSendingMethods": [ - "authorizationHeader" - ], - "clientId": "updated", + "resourceOwnerPassword": "pwd", "resourceOwnerUsername": "un", - "resourceOwnerPassword": "pwd" + "supportState": true, + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "useInApiDocumentation": true, + "useInTestConsole": false } } } - } + }, + "operationId": "AuthorizationServer_Update", + "title": "ApiManagementUpdateAuthorizationServer" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateBackend.json index 7e9846af0826..d8bae2386787 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateBackend.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateBackend.json @@ -1,11 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "backendId": "proxybackend", - "If-Match": "*", "parameters": { "properties": { "description": "description5308", @@ -14,25 +11,23 @@ "validateCertificateName": true } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", - "type": "Microsoft.ApiManagement/service/backends", "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", "properties": { "description": "description5308", - "url": "https://backendname2644/", - "protocol": "http", "credentials": { - "query": { - "sv": [ - "xx", - "bb", - "cc" - ] + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" }, "header": { "x-my-1": [ @@ -40,22 +35,29 @@ "val2" ] }, - "authorization": { - "scheme": "Basic", - "parameter": "opensesma" + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] } }, "proxy": { + "password": "", "url": "http://192.168.1.1:8080", - "username": "Contoso\\admin", - "password": "" + "username": "Contoso\\admin" }, "tls": { "validateCertificateChain": false, "validateCertificateName": true - } + }, + "url": "https://backendname2644/", + "protocol": "http" } } } - } + }, + "operationId": "Backend_Update", + "title": "ApiManagementUpdateBackend" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateCache.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateCache.json index b59f1d881d25..df3c9c879b9c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateCache.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateCache.json @@ -1,30 +1,32 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "cacheId": "c1", - "If-Match": "*", "parameters": { "properties": { "useFromLocation": "westindia" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", - "type": "Microsoft.ApiManagement/service/caches", "name": "c1", + "type": "Microsoft.ApiManagement/service/caches", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1", "properties": { - "useFromLocation": "westindia", "description": "Redis cache instances in West India", "connectionString": "{{5f7fbca77a891a2200f3db38}}", - "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1" + "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1", + "useFromLocation": "westindia" } } } - } + }, + "operationId": "Cache_Update", + "title": "ApiManagementUpdateCache" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateDiagnostic.json index 7c3a3cff114d..70b9e40ffda7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateDiagnostic.json @@ -1,111 +1,113 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "diagnosticId": "applicationinsights", - "If-Match": "*", "parameters": { "properties": { "alwaysLog": "allErrors", - "loggerId": "/loggers/applicationinsights", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "httpCorrelationProtocol": "Legacy", - "logClientIp": true, - "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } } } - } + }, + "operationId": "Diagnostic_Update", + "title": "ApiManagementUpdateDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateDocumentation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateDocumentation.json index c9f5218d44df..8e4f5d895c06 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateDocumentation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateDocumentation.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "documentationId": "57d1f7558aa04f15146d9d8a", "parameters": { "properties": { - "title": "Title updated", - "content": "content updated" + "content": "content updated", + "title": "Title updated" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", - "type": "Microsoft.ApiManagement/service/documentations", "name": "57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/documentations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a", "properties": { - "title": "Title updated", - "content": "content updated" + "content": "content updated", + "title": "Title updated" } } } - } + }, + "operationId": "Documentation_Update", + "title": "ApiManagementUpdateDocumentation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateGateway.json index 93af1fbf4398..2324434dd227 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateGateway.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateGateway.json @@ -1,11 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "gatewayId": "gw1", - "If-Match": "*", "parameters": { "properties": { "description": "my gateway 1", @@ -13,14 +10,17 @@ "name": "my location" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", - "type": "Microsoft.ApiManagement/service/gateways", "name": "a1", + "type": "Microsoft.ApiManagement/service/gateways", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1", "properties": { "description": "my gateway 1", "locationData": { @@ -29,5 +29,7 @@ } } } - } + }, + "operationId": "Gateway_Update", + "title": "ApiManagementUpdateGateway" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateGraphQLApiResolver.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateGraphQLApiResolver.json index 53e98bcc4897..7b9e77d515e7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateGraphQLApiResolver.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateGraphQLApiResolver.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "apiId": "echo-api", - "resolverId": "resolverId", - "If-Match": "*", "parameters": { "properties": { - "displayName": "Query AdminUsers", "path": "Query/adminUsers", - "description": "A GraphQL Resolver example" + "description": "A GraphQL Resolver example", + "displayName": "Query AdminUsers" } - } + }, + "resolverId": "resolverId", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/apis/resolvers", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/resolvers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/resolvers/57d2ef278aa04f0ad01d6cdc", "properties": { - "displayName": "Query AdminUsers", "path": "Query/adminUsers", - "description": "A GraphQL Resolver example" + "description": "A GraphQL Resolver example", + "displayName": "Query AdminUsers" } } } - } + }, + "operationId": "GraphQLApiResolver_Update", + "title": "ApiManagementUpdateGraphQLApiResolver" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateGroup.json index 86cb78edd550..55c7fa9f31df 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateGroup.json @@ -1,31 +1,33 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "groupId": "tempgroup", - "If-Match": "*", "parameters": { "properties": { "displayName": "temp group" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup", - "type": "Microsoft.ApiManagement/service/groups", "name": "tempgroup", + "type": "Microsoft.ApiManagement/service/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup", "properties": { - "displayName": "tempgroup", + "type": "external", "description": "awesome group of people", "builtIn": false, - "type": "external", + "displayName": "tempgroup", "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" } } } - } + }, + "operationId": "Group_Update", + "title": "ApiManagementUpdateGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateIdentityProvider.json index 3115a934ad14..ec730ad229c7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateIdentityProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateIdentityProvider.json @@ -1,37 +1,39 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "identityProviderName": "facebook", - "If-Match": "*", "parameters": { "properties": { "clientId": "updatedfacebookid", "clientSecret": "updatedfacebooksecret" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C", - "type": "Microsoft.ApiManagement/service/identityProviders", "name": "AadB2C", + "type": "Microsoft.ApiManagement/service/identityProviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C", "properties": { - "clientId": "f02dafe2-b8b8-48ec-a38e-27e5c16c51e5", "type": "aadB2C", - "authority": "login.microsoftonline.com", - "signinTenant": "contosoaadb2c.onmicrosoft.com", "allowedTenants": [ "contosoaadb2c.onmicrosoft.com", "contoso2aadb2c.onmicrosoft.com" ], - "signupPolicyName": "B2C_1_policy-signup", - "signinPolicyName": "B2C_1_policy-signin" + "authority": "login.microsoftonline.com", + "clientId": "f02dafe2-b8b8-48ec-a38e-27e5c16c51e5", + "signinPolicyName": "B2C_1_policy-signin", + "signinTenant": "contosoaadb2c.onmicrosoft.com", + "signupPolicyName": "B2C_1_policy-signup" } } } - } + }, + "operationId": "IdentityProvider_Update", + "title": "ApiManagementUpdateIdentityProvider" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateLogger.json index d7f9f3606657..c08b85851a57 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateLogger.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateLogger.json @@ -1,33 +1,35 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "loggerId": "eh1", - "If-Match": "*", "parameters": { "properties": { - "loggerType": "azureEventHub", - "description": "updating description" + "description": "updating description", + "loggerType": "azureEventHub" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1", - "type": "Microsoft.ApiManagement/service/loggers", "name": "eh1", + "type": "Microsoft.ApiManagement/service/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1", "properties": { - "loggerType": "azureEventHub", "description": "updating description", "credentials": { "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" }, - "isBuffered": true + "isBuffered": true, + "loggerType": "azureEventHub" } } } - } + }, + "operationId": "Logger_Update", + "title": "ApiManagementUpdateLogger" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateNamedValue.json index 5b2e5793b3e2..2021f6d6812f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateNamedValue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateNamedValue.json @@ -1,44 +1,46 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "namedValueId": "testprop2", - "If-Match": "*", "parameters": { "properties": { "displayName": "prop3name", - "value": "propValue", + "secret": false, "tags": [ "foo", "bar2" ], - "secret": false + "value": "propValue" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", "properties": { "displayName": "prop3name", - "value": "propValue", + "secret": false, "tags": [ "foo", "bar2" ], - "secret": false + "value": "propValue" } } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } } - } + }, + "operationId": "NamedValue_Update", + "title": "ApiManagementUpdateNamedValue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json index 4694357549ff..c24e39e71187 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json @@ -1,34 +1,36 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "opid": "templateOpenIdConnect2", - "If-Match": "*", "parameters": { "properties": { "clientSecret": "updatedsecret", - "useInTestConsole": false, - "useInApiDocumentation": true + "useInApiDocumentation": true, + "useInTestConsole": false } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", - "type": "Microsoft.ApiManagement/service/openidconnectproviders", "name": "templateOpenIdConnect2", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", "properties": { - "displayName": "templateoidprovider2", "description": "open id provider template2", - "metadataEndpoint": "https://oidprovider-template2.net", "clientId": "oidprovidertemplate2", - "useInTestConsole": false, - "useInApiDocumentation": true + "displayName": "templateoidprovider2", + "metadataEndpoint": "https://oidprovider-template2.net", + "useInApiDocumentation": true, + "useInTestConsole": false } } } - } + }, + "operationId": "OpenIdConnectProvider_Update", + "title": "ApiManagementUpdateOpenIdConnectProvider" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdatePolicyRestriction.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdatePolicyRestriction.json index d91241ce4970..7e4af2f9a6ad 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdatePolicyRestriction.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdatePolicyRestriction.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "policyRestrictionId": "policyRestriction1", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "scope": "Sample Path 2 to the policy document." } - } + }, + "policyRestrictionId": "policyRestriction1", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", - "type": "Microsoft.ApiManagement/service/policyRestrictions", "name": "policyRestriction1", + "type": "Microsoft.ApiManagement/service/policyRestrictions", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1", "properties": { - "scope": "Sample Path 2 to the policy document.", - "requireBase": "true" + "requireBase": "true", + "scope": "Sample Path 2 to the policy document." } } } - } + }, + "operationId": "PolicyRestriction_Update", + "title": "ApiManagementUpdatePolicyRestriction" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdatePortalConfig.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdatePortalConfig.json index 5df31e7abec2..f1f5276c036f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdatePortalConfig.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdatePortalConfig.json @@ -1,22 +1,22 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "portalConfigId": "default", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { - "enableBasicAuth": true, - "signin": { - "require": false + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] }, - "signup": { - "termsOfService": { - "text": "I agree to the service terms and conditions.", - "requireConsent": false - } + "csp": { + "allowedSources": [ + "*.contoso.com" + ], + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ] }, "delegation": { "delegateRegistration": false, @@ -24,39 +24,43 @@ "delegationUrl": null, "validationKey": null }, - "csp": { - "mode": "reportOnly", - "reportUri": [ - "https://report.contoso.com" - ], - "allowedSources": [ - "*.contoso.com" - ] + "enableBasicAuth": true, + "signin": { + "require": false }, - "cors": { - "allowedOrigins": [ - "https://contoso.com" - ] + "signup": { + "termsOfService": { + "requireConsent": false, + "text": "I agree to the service terms and conditions." + } } } - } + }, + "portalConfigId": "default", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", - "type": "Microsoft.ApiManagement/service/portalconfigs", "name": "default", + "type": "Microsoft.ApiManagement/service/portalconfigs", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default", "properties": { - "enableBasicAuth": true, - "signin": { - "require": false + "cors": { + "allowedOrigins": [ + "https://contoso.com" + ] }, - "signup": { - "termsOfService": { - "text": "I agree to the service terms and conditions.", - "requireConsent": false - } + "csp": { + "allowedSources": [ + "*.contoso.com" + ], + "mode": "reportOnly", + "reportUri": [ + "https://report.contoso.com" + ] }, "delegation": { "delegateRegistration": false, @@ -64,22 +68,20 @@ "delegationUrl": null, "validationKey": null }, - "csp": { - "mode": "reportOnly", - "reportUri": [ - "https://report.contoso.com" - ], - "allowedSources": [ - "*.contoso.com" - ] + "enableBasicAuth": true, + "signin": { + "require": false }, - "cors": { - "allowedOrigins": [ - "https://contoso.com" - ] + "signup": { + "termsOfService": { + "requireConsent": false, + "text": "I agree to the service terms and conditions." + } } } } } - } + }, + "operationId": "PortalConfig_Update", + "title": "ApiManagementUpdatePortalConfig" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdatePortalRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdatePortalRevision.json index 5fd9082fd6e1..e9f759ecf6da 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdatePortalRevision.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdatePortalRevision.json @@ -1,39 +1,41 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "portalRevisionId": "20201112101010", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "description": "portal revision update", "isCurrent": true } - } + }, + "portalRevisionId": "20201112101010", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2024-10-01-preview&asyncId=5faf16b81d9a028970d0bfbb&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5faf16b81d9a028970d0bfbb?api-version=2024-10-01-preview" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", - "type": "Microsoft.ApiManagement/service/portalRevisions", "name": "20201112101010", + "type": "Microsoft.ApiManagement/service/portalRevisions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2", "properties": { "description": "portal revision update", - "statusDetails": null, - "status": "completed", - "isCurrent": true, "createdDateTime": "2020-11-13T22:47:13.397Z", + "isCurrent": true, + "status": "completed", + "statusDetails": null, "updatedDateTime": "2020-11-13T23:29:25.34Z" } } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5faf16b81d9a028970d0bfbb?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2024-10-01-preview&asyncId=5faf16b81d9a028970d0bfbb&asyncCode=200" + } } - } + }, + "operationId": "PortalRevision_Update", + "title": "ApiManagementUpdatePortalRevision" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateProduct.json index e5b35983b4d1..8c4285316e5e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateProduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateProduct.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "testproduct", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "displayName": "Test Template ProductName 4" } - } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct", - "type": "Microsoft.ApiManagement/service/products", "name": "testproduct", + "type": "Microsoft.ApiManagement/service/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct", "properties": { - "displayName": "Test Template ProductName 4", "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", - "subscriptionRequired": true, "approvalRequired": true, - "subscriptionsLimit": 1, - "state": "published" + "displayName": "Test Template ProductName 4", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1 } } } - } + }, + "operationId": "Product_Update", + "title": "ApiManagementUpdateProduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateProductWiki.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateProductWiki.json index 87ab2266576f..61df3599607a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateProductWiki.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateProductWiki.json @@ -1,11 +1,7 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "productId": "57d1f7558aa04f15146d9d8a", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "documents": [ @@ -14,14 +10,18 @@ } ] } - } + }, + "productId": "57d1f7558aa04f15146d9d8a", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", - "type": "Microsoft.ApiManagement/service/products/wikis", "name": "default", + "type": "Microsoft.ApiManagement/service/products/wikis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/57d1f7558aa04f15146d9d8a/wikis/default", "properties": { "documents": [ { @@ -31,5 +31,7 @@ } } } - } + }, + "operationId": "ProductWiki_Update", + "title": "ApiManagementUpdateProductWiki" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateQuotaCounterKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateQuotaCounterKey.json index 7f7d9eb26037..2c38708e30fc 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateQuotaCounterKey.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateQuotaCounterKey.json @@ -1,34 +1,36 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "quotaCounterKey": "ba", "parameters": { "properties": { "callsCount": 0, "kbTransferred": 2.5630078125 } - } + }, + "quotaCounterKey": "ba", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": "", "value": [ { "counterKey": "ba", + "periodEndTime": "2018-02-08T16:54:40Z", "periodKey": "0_P3Y6M4DT12H30M5S", "periodStartTime": "2014-08-04T04:24:35Z", - "periodEndTime": "2018-02-08T16:54:40Z", "value": { "callsCount": 5, "kbTransferred": 2.5830078125 } } - ], - "nextLink": "" + ] } } - } + }, + "operationId": "QuotaByCounterKeys_Update", + "title": "ApiManagementUpdateQuotaCounterKey" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json index cbabea6ebd62..9e58b559bcf3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json @@ -1,30 +1,32 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "quotaCounterKey": "ba", - "quotaPeriodKey": "0_P3Y6M4DT12H30M5S", "parameters": { "properties": { "callsCount": 0, "kbTransferred": 0 } - } + }, + "quotaCounterKey": "ba", + "quotaPeriodKey": "0_P3Y6M4DT12H30M5S", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "counterKey": "ba", + "periodEndTime": "2018-02-08T16:54:40Z", "periodKey": "0_P3Y6M4DT12H30M5S", "periodStartTime": "2014-08-04T04:24:35Z", - "periodEndTime": "2018-02-08T16:54:40Z", "value": { "callsCount": 0, "kbTransferred": 2.5625 } } } - } + }, + "operationId": "QuotaByPeriodKeys_Update", + "title": "ApiManagementUpdateQuotaCounterKeyByQuotaPeriod" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateServiceDisableTls10.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateServiceDisableTls10.json index 0071dad4605d..fd4022858935 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateServiceDisableTls10.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateServiceDisableTls10.json @@ -1,64 +1,66 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { "properties": { "customProperties": { "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "Owner": "sasolank", - "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3", - "Reserved": "", - "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT", - "Pool": "Manual", - "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT" - }, - "location": "West US", "etag": "AAAAAAAYRPs=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "West US", "properties": { - "publisherEmail": "admin@live.com", - "publisherName": "Contoso", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", "createdAtUtc": "2017-06-29T17:50:42.3191122Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False" + }, "gatewayUrl": "https://apimService1.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", "hostnameConfigurations": [], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", "publicIPAddresses": [ "40.86.176.232" ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False" - }, + "publisherEmail": "admin@live.com", + "publisherName": "Contoso", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", "virtualNetworkType": "None" }, "sku": { "name": "Standard", "capacity": 1 + }, + "tags": { + "Owner": "sasolank", + "Pool": "Manual", + "Reserved": "", + "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT", + "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT", + "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3" } } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } } - } + }, + "operationId": "ApiManagementService_Update", + "title": "ApiManagementUpdateServiceDisableTls10" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateServicePublisherDetails.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateServicePublisherDetails.json index 69cc7244831b..cfcc82e3dbde 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateServicePublisherDetails.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateServicePublisherDetails.json @@ -1,63 +1,65 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { "properties": { "publisherEmail": "foobar@live.com", "publisherName": "Contoso Vnext" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "tags": { - "Owner": "sasolank", - "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3", - "Reserved": "", - "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT", - "Pool": "Manual", - "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT" - }, - "location": "West US", "etag": "AAAAAAAYRPs=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "West US", "properties": { - "publisherEmail": "foobar@live.com", - "publisherName": "Contoso Vnext", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", "createdAtUtc": "2017-06-29T17:50:42.3191122Z", + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False" + }, "gatewayUrl": "https://apimService1.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", "hostnameConfigurations": [], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", "publicIPAddresses": [ "40.86.176.232" ], - "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False" - }, + "publisherEmail": "foobar@live.com", + "publisherName": "Contoso Vnext", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", "virtualNetworkType": "None" }, "sku": { "name": "Standard", "capacity": 1 + }, + "tags": { + "Owner": "sasolank", + "Pool": "Manual", + "Reserved": "", + "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT", + "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT", + "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3" } } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + } } - } + }, + "operationId": "ApiManagementService_Update", + "title": "ApiManagementUpdateServicePublisherDetails" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json index 6021f191ff23..70c9804eb46c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json @@ -1,34 +1,31 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters": { "properties": { "additionalLocations": [ { "location": "Australia East", + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip", "sku": { "name": "Premium", "capacity": 3 }, + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default" + }, "zones": [ "1", "2", "3" - ], - "virtualNetworkConfiguration": { - "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default" - }, - "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip" + ] } ], + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east", "virtualNetworkConfiguration": { "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2" }, - "virtualNetworkType": "External", - "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east" + "virtualNetworkType": "External" }, "sku": { "name": "Premium", @@ -39,124 +36,129 @@ "2", "3" ] - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", "name": "apimService1", "type": "Microsoft.ApiManagement/service", - "location": "Japan East", "etag": "AAAAAAAWBIU=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "location": "Japan East", "properties": { - "publisherEmail": "contoso@microsoft.com", - "publisherName": "apimPublisher", - "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2021-04-08T23:41:35.6447381Z", - "gatewayUrl": "https://apimService1.azure-api.net", - "gatewayRegionalUrl": "https://apimService1-japaneast-01.regional.azure-api.net", - "portalUrl": "https://apimService1.portal.azure-api.net", - "developerPortalUrl": "https://apimService1.developer.azure-api.net", - "managementApiUrl": "https://apimService1.management.azure-api.net", - "scmUrl": "https://apimService1.scm.azure-api.net", - "hostnameConfigurations": [ - { - "type": "Proxy", - "hostName": "apimService1.azure-api.net", - "negotiateClientCertificate": false, - "defaultSslBinding": false, - "certificateSource": "BuiltIn" - }, - { - "type": "Proxy", - "hostName": "mycustomdomain.int-azure-api.net", - "negotiateClientCertificate": false, - "certificate": { - "expiry": "2022-06-09T23:59:59+00:00", - "thumbprint": "2994B5FFB8F76B3C687D324A8DEE0432C1ED18CD", - "subject": "CN=mycustomdomain.int-azure-api.net" - }, - "defaultSslBinding": true, - "certificateSource": "Managed" - } - ], - "publicIPAddresses": [ - "20.78.248.217" - ], "additionalLocations": [ { + "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-australiaeast-01.regional.azure-api.net", "location": "Australia East", + "platformVersion": "stv2", + "publicIPAddresses": [ + "20.213.1.35" + ], + "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip", "sku": { "name": "Premium", "capacity": 3 }, + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default" + }, "zones": [ "1", "2", "3" - ], - "publicIPAddresses": [ - "20.213.1.35" - ], - "virtualNetworkConfiguration": { - "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default" - }, - "gatewayRegionalUrl": "https://apimService1-australiaeast-01.regional.azure-api.net", - "disableGateway": false, - "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip", - "platformVersion": "stv2" + ] } ], - "virtualNetworkConfiguration": { - "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2" - }, + "createdAtUtc": "2021-04-08T23:41:35.6447381Z", "customProperties": { - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA": "false", "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256": "false", "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256": "false", "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false", "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false", - "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false" + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false" }, - "virtualNetworkType": "Internal", + "developerPortalUrl": "https://apimService1.developer.azure-api.net", "disableGateway": false, + "gatewayRegionalUrl": "https://apimService1-japaneast-01.regional.azure-api.net", + "gatewayUrl": "https://apimService1.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "certificateSource": "BuiltIn", + "defaultSslBinding": false, + "hostName": "apimService1.azure-api.net", + "negotiateClientCertificate": false + }, + { + "type": "Proxy", + "certificate": { + "expiry": "2022-06-09T23:59:59+00:00", + "subject": "CN=mycustomdomain.int-azure-api.net", + "thumbprint": "2994B5FFB8F76B3C687D324A8DEE0432C1ED18CD" + }, + "certificateSource": "Managed", + "defaultSslBinding": true, + "hostName": "mycustomdomain.int-azure-api.net", + "negotiateClientCertificate": false + } + ], + "managementApiUrl": "https://apimService1.management.azure-api.net", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "platformVersion": "stv2", + "portalUrl": "https://apimService1.portal.azure-api.net", + "provisioningState": "Succeeded", + "publicIPAddresses": [ + "20.78.248.217" + ], "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east", "publicNetworkAccess": "Enabled", - "platformVersion": "stv2" + "publisherEmail": "contoso@microsoft.com", + "publisherName": "apimPublisher", + "scmUrl": "https://apimService1.scm.azure-api.net", + "targetProvisioningState": "", + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2" + }, + "virtualNetworkType": "Internal" }, "sku": { "name": "Premium", "capacity": 3 }, + "systemData": { + "lastModifiedAt": "2022-01-21T20:04:21.6108974Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User" + }, "zones": [ "1", "2", "3" - ], - "systemData": { - "lastModifiedBy": "contoso@microsoft.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-01-21T20:04:21.6108974Z" - } + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiManagementService_Update", + "title": "ApiManagementUpdateServiceToNewVnetAndAvailabilityZones" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateStandardGateway.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateStandardGateway.json index 248256edd780..d1fcc260ce61 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateStandardGateway.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateStandardGateway.json @@ -1,9 +1,7 @@ { "parameters": { - "gatewayName": "apimGateway1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "gatewayName": "apimGateway1", "parameters": { "properties": {}, "sku": { @@ -14,26 +12,19 @@ "Name": "Contoso", "Test": "User" } - } + }, + "resourceGroupName": "rg1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", "name": "apimGateway1", "type": "Microsoft.ApiManagement/gateways", - "tags": { - "api-version": "2024-10-01-preview" - }, - "location": "East US", "etag": "AAAAAAAmREI=", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1", + "location": "East US", "properties": { - "provisioningState": "Succeeded", - "targetProvisioningState": "", - "createdAtUtc": "2022-07-11T18:41:01.2506031Z", - "frontend": { - "defaultHostname": "apimGateway1.eastus.gateway.azure-api.net" - }, "backend": { "subnet": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1" @@ -41,27 +32,38 @@ }, "configurationApi": { "hostname": "apimGateway1.eastus.configuration.gateway.azure-api.net" - } + }, + "createdAtUtc": "2022-07-11T18:41:01.2506031Z", + "frontend": { + "defaultHostname": "apimGateway1.eastus.gateway.azure-api.net" + }, + "provisioningState": "Succeeded", + "targetProvisioningState": "" }, "sku": { "name": "Standard", "capacity": 1 }, "systemData": { + "createdAt": "2022-07-11T18:41:00.9390609Z", "createdBy": "user@contoso.com", "createdByType": "User", - "createdAt": "2022-07-11T18:41:00.9390609Z", + "lastModifiedAt": "2022-07-11T18:41:00.9390609Z", "lastModifiedBy": "user@contoso.com", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-07-11T18:41:00.9390609Z" + "lastModifiedByType": "User" + }, + "tags": { + "api-version": "2024-10-01-preview" } } }, "202": { "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-10-01-preview&asyncResponse" } } - } + }, + "operationId": "ApiGateway_Update", + "title": "ApiManagementUpdateStandardGateway" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateSubscription.json index adc20dd23361..8bfdfb70e51d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateSubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateSubscription.json @@ -1,31 +1,33 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "sid": "testsub", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "displayName": "testsub" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub", - "type": "Microsoft.ApiManagement/service/subscriptions", "name": "testsub", + "type": "Microsoft.ApiManagement/service/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub", "properties": { + "createdDate": "2017-06-02T17:59:06.223Z", + "displayName": "testsub", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", - "displayName": "testsub", - "state": "submitted", - "createdDate": "2017-06-02T17:59:06.223Z" + "state": "submitted" } } } - } + }, + "operationId": "Subscription_Update", + "title": "ApiManagementUpdateSubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateTag.json index 4107046607f2..3d9a6811b204 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateTag.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "tagId": "temptag", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "displayName": "temp tag" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "temptag" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/temptag", - "type": "Microsoft.ApiManagement/service/tags", "name": "temptag", + "type": "Microsoft.ApiManagement/service/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/temptag", "properties": { "displayName": "tag1" } } } - } + }, + "operationId": "Tag_Update", + "title": "ApiManagementUpdateTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateTemplate.json index 505e91b5da6a..be42ad92e4c4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateTemplate.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateTemplate.json @@ -1,29 +1,27 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "templateName": "newIssueNotificationMessage", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { - "subject": "Your request $IssueName was received", - "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

\r\n We are happy to let you know that your request to publish the $AppName application in the gallery has been approved. Your application has been published and can be viewed here.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n" + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

\r\n We are happy to let you know that your request to publish the $AppName application in the gallery has been approved. Your application has been published and can be viewed here.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "subject": "Your request $IssueName was received" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "templateName": "newIssueNotificationMessage" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", - "type": "Microsoft.ApiManagement/service/templates", "name": "NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", "properties": { - "subject": "Your request $IssueName was received", - "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", - "title": "New issue received", "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", "isDefault": true, "parameters": [ { @@ -50,9 +48,13 @@ "name": "DevPortalUrl", "title": "Developer portal URL" } - ] + ], + "subject": "Your request $IssueName was received", + "title": "New issue received" } } } - } + }, + "operationId": "EmailTemplate_Update", + "title": "ApiManagementUpdateTemplate" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateTenantAccess.json index ca8522e91f52..5fe24d0961aa 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateTenantAccess.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateTenantAccess.json @@ -1,27 +1,29 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "If-Match": "*", "accessName": "access", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "enabled": true } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", - "type": "Microsoft.ApiManagement/service/tenant", "name": "access", + "type": "Microsoft.ApiManagement/service/tenant", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access", "properties": { "enabled": true } } } - } + }, + "operationId": "TenantAccess_Update", + "title": "ApiManagementUpdateTenantAccess" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateUser.json index e23d831c059f..a34f719e8fc2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateUser.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateUser.json @@ -1,39 +1,41 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userId": "5931a75ae4bbd512a88c680b", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { + "email": "foobar@outlook.com", "firstName": "foo", - "lastName": "bar", - "email": "foobar@outlook.com" + "lastName": "bar" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "5931a75ae4bbd512a88c680b" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", - "type": "Microsoft.ApiManagement/service/users", "name": "5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/users", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", "properties": { - "firstName": "foo", - "lastName": "bar", "email": "foobar@outlook.com", - "state": "active", - "registrationDate": "2017-06-02T17:58:50.357Z", + "firstName": "foo", "identities": [ { - "provider": "Microsoft", - "id": "*************" + "id": "*************", + "provider": "Microsoft" } - ] + ], + "lastName": "bar", + "registrationDate": "2017-06-02T17:58:50.357Z", + "state": "active" } } } - } + }, + "operationId": "User_Update", + "title": "ApiManagementUpdateUser" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspace.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspace.json index 3c702702399c..66835e5f937d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspace.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspace.json @@ -1,29 +1,31 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { - "displayName": "my workspace", - "description": "workspace 1" + "description": "workspace 1", + "displayName": "my workspace" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", - "type": "Microsoft.ApiManagement/service/workspaces", "name": "wks1", + "type": "Microsoft.ApiManagement/service/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1", "properties": { "description": "workspace 1", "displayName": "my workspace" } } } - } + }, + "operationId": "Workspace_Update", + "title": "ApiManagementUpdateWorkspace" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApi.json index 0a26ffe29dec..1b54df93b89e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApi.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApi.json @@ -1,42 +1,44 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "echo-api", - "If-Match": "*", "parameters": { "properties": { + "path": "newecho", "displayName": "Echo API New", - "serviceUrl": "http://echoapi.cloudapp.net/api2", - "path": "newecho" + "serviceUrl": "http://echoapi.cloudapp.net/api2" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api", - "type": "Microsoft.ApiManagement/service/workspaces/pis", "name": "echo-api", + "type": "Microsoft.ApiManagement/service/workspaces/pis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api", "properties": { - "displayName": "Echo API New", - "apiRevision": "1", - "serviceUrl": "http://echoapi.cloudapp.net/api2", "path": "newecho", + "apiRevision": "1", + "displayName": "Echo API New", + "isCurrent": true, + "isOnline": true, "protocols": [ "https" ], + "serviceUrl": "http://echoapi.cloudapp.net/api2", "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - }, - "isCurrent": true, - "isOnline": true + } } } } - } + }, + "operationId": "WorkspaceApi_Update", + "title": "ApiManagementUpdateWorkspaceApi" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiDiagnostic.json index 2a8ac76b68d5..3c3d92992b3d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiDiagnostic.json @@ -1,105 +1,107 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "diagnosticId": "applicationinsights", "apiId": "echo-api", - "If-Match": "*", + "diagnosticId": "applicationinsights", "parameters": { "properties": { "alwaysLog": "allErrors", - "loggerId": "/workspaces/wks1/loggers/applicationinsights", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "httpCorrelationProtocol": "Legacy", - "logClientIp": true, - "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", - "sampling": { - "samplingType": "fixed", - "percentage": 100 - }, - "frontend": { - "request": { - "headers": [], + "backend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } }, - "backend": { - "request": { - "headers": [], + "frontend": { + "response": { "body": { "bytes": 100 - } + }, + "headers": [] }, - "response": { - "headers": [], + "request": { "body": { "bytes": 100 - } + }, + "headers": [] } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "percentage": 100, + "samplingType": "fixed" } } } } - } + }, + "operationId": "WorkspaceApiDiagnostic_Update", + "title": "ApiManagementUpdateWorkspaceApiDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiOperation.json index 3a083eac947b..7d8d78ebe10a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiOperation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiOperation.json @@ -1,25 +1,21 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "apiId": "echo-api", "operationId": "operationId", "If-Match": "*", + "api-version": "2024-10-01-preview", + "apiId": "echo-api", "parameters": { "properties": { - "displayName": "Retrieve resource", "method": "GET", - "urlTemplate": "/resource", + "displayName": "Retrieve resource", "templateParameters": [], + "urlTemplate": "/resource", "request": { "queryParameters": [ { "name": "param1", - "description": "A sample parameter that is required and has a default value of \"sample\".", "type": "string", + "description": "A sample parameter that is required and has a default value of \"sample\".", "defaultValue": "sample", "required": true, "values": [ @@ -30,36 +26,40 @@ }, "responses": [ { - "statusCode": 200, "description": "Returned in all cases.", + "headers": [], "representations": [], - "headers": [] + "statusCode": 200 }, { - "statusCode": 500, "description": "Server Error.", + "headers": [], "representations": [], - "headers": [] + "statusCode": 500 } ] } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", - "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", "name": "57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/workspaces/apis/operations", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", "properties": { - "displayName": "CancelOrder", "method": "POST", - "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", + "displayName": "CancelOrder", "templateParameters": [], + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", "request": { "description": "IFazioService_CancelOrder_InputMessage", - "queryParameters": [], "headers": [], + "queryParameters": [], "representations": [ { "contentType": "text/xml", @@ -70,8 +70,8 @@ }, "responses": [ { - "statusCode": 200, "description": "IFazioService_CancelOrder_OutputMessage", + "headers": [], "representations": [ { "contentType": "text/xml", @@ -79,11 +79,13 @@ "typeName": "CancelOrderResponse" } ], - "headers": [] + "statusCode": 200 } ] } } } - } + }, + "operationId": "WorkspaceApiOperation_Update", + "title": "ApiManagementUpdateWorkspaceApiOperation" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiRelease.json index ed8887aff75f..7eb8b364b64b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiRelease.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiRelease.json @@ -1,33 +1,35 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "apiId": "a1", - "releaseId": "testrev", - "If-Match": "*", "parameters": { "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", "notes": "yahooagain" } - } + }, + "releaseId": "testrev", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/testrev", - "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", "name": "testrev", + "type": "Microsoft.ApiManagement/service/workspaces/apis/releases", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1/releases/testrev", "properties": { "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1", "createdDateTime": "2018-02-08T20:38:29.173Z", - "updatedDateTime": "2018-02-08T20:38:29.173Z", - "notes": "yahoo" + "notes": "yahoo", + "updatedDateTime": "2018-02-08T20:38:29.173Z" } } } - } + }, + "operationId": "WorkspaceApiRelease_Update", + "title": "ApiManagementUpdateWorkspaceApiRelease" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiVersionSet.json index 5c1436eb780d..73ed166cea39 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiVersionSet.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceApiVersionSet.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "versionSetId": "vs1", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { + "description": "Version configuration", "displayName": "api set 1", - "versioningScheme": "Segment", - "description": "Version configuration" + "versioningScheme": "Segment" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "versionSetId": "vs1", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs1", - "type": "Microsoft.ApiManagement/service/workspaces.api-version-sets", "name": "vs1", + "type": "Microsoft.ApiManagement/service/workspaces.api-version-sets", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apiVersionSets/vs1", "properties": { + "description": "Version configuration", "displayName": "api set 1", - "versioningScheme": "Segment", - "description": "Version configuration" + "versioningScheme": "Segment" } } } - } + }, + "operationId": "WorkspaceApiVersionSet_Update", + "title": "ApiManagementUpdateWorkspaceApiVersionSet" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceBackend.json index 7a76b576e282..190fb0419d87 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceBackend.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceBackend.json @@ -1,12 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "backendId": "proxybackend", - "If-Match": "*", "parameters": { "properties": { "description": "description5308", @@ -15,25 +11,24 @@ "validateCertificateName": true } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", - "type": "Microsoft.ApiManagement/service/workspaces/backends", "name": "proxybackend", + "type": "Microsoft.ApiManagement/service/workspaces/backends", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/proxybackend", "properties": { "description": "description5308", - "url": "https://backendname2644/", - "protocol": "http", "credentials": { - "query": { - "sv": [ - "xx", - "bb", - "cc" - ] + "authorization": { + "parameter": "opensesma", + "scheme": "Basic" }, "header": { "x-my-1": [ @@ -41,22 +36,29 @@ "val2" ] }, - "authorization": { - "scheme": "Basic", - "parameter": "opensesma" + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] } }, "proxy": { + "password": "", "url": "http://192.168.1.1:8080", - "username": "Contoso\\admin", - "password": "" + "username": "Contoso\\admin" }, "tls": { "validateCertificateChain": false, "validateCertificateName": true - } + }, + "url": "https://backendname2644/", + "protocol": "http" } } } - } + }, + "operationId": "WorkspaceBackend_Update", + "title": "ApiManagementUpdateWorkspaceBackend" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceDiagnostic.json index ac1ab34d578d..080abc2b635f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceDiagnostic.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceDiagnostic.json @@ -1,112 +1,114 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "diagnosticId": "applicationinsights", - "If-Match": "*", "parameters": { "properties": { "alwaysLog": "allErrors", - "loggerId": "/workspaces/wks1/loggers/applicationinsights", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "loggerId": "/workspaces/wks1/loggers/applicationinsights", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", - "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", "name": "applicationinsights", + "type": "Microsoft.ApiManagement/service/workspaces/diagnostics", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights", "properties": { "alwaysLog": "allErrors", - "httpCorrelationProtocol": "Legacy", - "logClientIp": true, - "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", - "sampling": { - "samplingType": "fixed", - "percentage": 50 - }, - "frontend": { - "request": { - "headers": [ - "Content-type" - ], + "backend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } - } - }, - "backend": { - "request": { + }, "headers": [ "Content-type" - ], + ] + } + }, + "frontend": { + "response": { "body": { "bytes": 512 - } - }, - "response": { + }, "headers": [ "Content-type" - ], + ] + }, + "request": { "body": { "bytes": 512 - } + }, + "headers": [ + "Content-type" + ] } + }, + "httpCorrelationProtocol": "Legacy", + "logClientIp": true, + "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/aisamplingtest", + "sampling": { + "percentage": 50, + "samplingType": "fixed" } } } } - } + }, + "operationId": "WorkspaceDiagnostic_Update", + "title": "ApiManagementUpdateWorkspaceDiagnostic" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceGroup.json index 8af47e7eb55f..9d1b2d3b99e4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceGroup.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceGroup.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "groupId": "tempgroup", - "If-Match": "*", "parameters": { "properties": { "displayName": "temp group" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup", - "type": "Microsoft.ApiManagement/service/workspaces/groups", "name": "tempgroup", + "type": "Microsoft.ApiManagement/service/workspaces/groups", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/groups/tempgroup", "properties": { - "displayName": "tempgroup", + "type": "external", "description": "awesome group of people", "builtIn": false, - "type": "external", + "displayName": "tempgroup", "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" } } } - } + }, + "operationId": "WorkspaceGroup_Update", + "title": "ApiManagementUpdateWorkspaceGroup" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceLogger.json index b6c7bcf1d99a..6506cc483a76 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceLogger.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceLogger.json @@ -1,34 +1,36 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "loggerId": "eh1", - "If-Match": "*", "parameters": { "properties": { - "loggerType": "azureEventHub", - "description": "updating description" + "description": "updating description", + "loggerType": "azureEventHub" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1", - "type": "Microsoft.ApiManagement/service/workspaces/loggers", "name": "eh1", + "type": "Microsoft.ApiManagement/service/workspaces/loggers", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1", "properties": { - "loggerType": "azureEventHub", "description": "updating description", "credentials": { "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}" }, - "isBuffered": true + "isBuffered": true, + "loggerType": "azureEventHub" } } } - } + }, + "operationId": "WorkspaceLogger_Update", + "title": "ApiManagementUpdateWorkspaceLogger" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceNamedValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceNamedValue.json index 823e8f01a761..195a4834731c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceNamedValue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceNamedValue.json @@ -1,45 +1,47 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", + "If-Match": "*", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", "namedValueId": "testprop2", - "If-Match": "*", "parameters": { "properties": { "displayName": "prop3name", - "value": "propValue", + "secret": false, "tags": [ "foo", "bar2" ], - "secret": false + "value": "propValue" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview" - } - }, "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2", "type": "Microsoft.ApiManagement/service/namedValues", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2", "properties": { "displayName": "prop3name", - "value": "propValue", + "secret": false, "tags": [ "foo", "bar2" ], - "secret": false + "value": "propValue" } } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-10-01-preview", + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop2?api-version=2024-10-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=200" + } } - } + }, + "operationId": "WorkspaceNamedValue_Update", + "title": "ApiManagementUpdateWorkspaceNamedValue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceProduct.json index d85d854adef9..ac24e9e85068 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceProduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceProduct.json @@ -1,33 +1,35 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "productId": "testproduct", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "displayName": "Test Template ProductName 4" } - } + }, + "productId": "testproduct", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct", - "type": "Microsoft.ApiManagement/service/workspaces/products", "name": "testproduct", + "type": "Microsoft.ApiManagement/service/workspaces/products", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/testproduct", "properties": { - "displayName": "Test Template ProductName 4", "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", - "subscriptionRequired": true, "approvalRequired": true, - "subscriptionsLimit": 1, - "state": "published" + "displayName": "Test Template ProductName 4", + "state": "published", + "subscriptionRequired": true, + "subscriptionsLimit": 1 } } } - } + }, + "operationId": "WorkspaceProduct_Update", + "title": "ApiManagementUpdateWorkspaceProduct" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceSubscription.json index 4c4e730d3070..c81b7e2b0d00 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceSubscription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceSubscription.json @@ -1,32 +1,34 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "sid": "testsub", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "displayName": "testsub" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub", - "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", "name": "testsub", + "type": "Microsoft.ApiManagement/service/workspaces/subscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub", "properties": { + "createdDate": "2017-06-02T17:59:06.223Z", + "displayName": "testsub", "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002", - "displayName": "testsub", - "state": "submitted", - "createdDate": "2017-06-02T17:59:06.223Z" + "state": "submitted" } } } - } + }, + "operationId": "WorkspaceSubscription_Update", + "title": "ApiManagementUpdateWorkspaceSubscription" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceTag.json index ec245561b68f..af5fd724428d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUpdateWorkspaceTag.json @@ -1,28 +1,30 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "tagId": "temptag", "If-Match": "*", + "api-version": "2024-10-01-preview", "parameters": { "properties": { "displayName": "temp tag" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "tagId": "temptag", + "workspaceId": "wks1" }, "responses": { "200": { "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/temptag", - "type": "Microsoft.ApiManagement/service/workspaces/tags", "name": "temptag", + "type": "Microsoft.ApiManagement/service/workspaces/tags", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/tags/temptag", "properties": { "displayName": "tag1" } } } - } + }, + "operationId": "WorkspaceTag_Update", + "title": "ApiManagementUpdateWorkspaceTag" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUserConfirmationPasswordSend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUserConfirmationPasswordSend.json index 939847fbda9b..1c25dc7d0f87 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUserConfirmationPasswordSend.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUserConfirmationPasswordSend.json @@ -1,12 +1,14 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "userId": "57127d485157a511ace86ae7" }, "responses": { "204": {} - } + }, + "operationId": "UserConfirmationPassword_Send", + "title": "ApiManagementUserConfirmationPasswordSend" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUserGenerateSsoUrl.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUserGenerateSsoUrl.json index 456859b57710..50e345c8276d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUserGenerateSsoUrl.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUserGenerateSsoUrl.json @@ -1,8 +1,8 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", "userId": "57127d485157a511ace86ae7" }, @@ -12,5 +12,7 @@ "value": "https://apimService1.portal.azure-api.net/signin-sso?token=57127d485157a511ace86ae7%26201706051624%267VY18MlwAom***********2bYr2bDQHg21OzQsNakExQ%3d%3d" } } - } + }, + "operationId": "User_GenerateSsoUrl", + "title": "ApiManagementUserGenerateSsoUrl" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUserToken.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUserToken.json index 93770ee2737e..03c911748e23 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUserToken.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementUserToken.json @@ -1,16 +1,16 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userId": "userId1718", "parameters": { "properties": { - "keyType": "primary", - "expiry": "2019-04-21T00:44:24.2845269Z" + "expiry": "2019-04-21T00:44:24.2845269Z", + "keyType": "primary" } - } + }, + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userId": "userId1718" }, "responses": { "200": { @@ -18,5 +18,7 @@ "value": "userId1718&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg==" } } - } + }, + "operationId": "User_GetSharedAccessToken", + "title": "ApiManagementUserToken" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementValidatePolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementValidatePolicies.json index ca3ef08a7ae1..107f207c4b94 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementValidatePolicies.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementValidatePolicies.json @@ -1,29 +1,31 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ApiManagement/service/apimService1/validatePolicies?api-version=2023-05-01" - } - }, "200": { "body": { - "id": "6074e652093a9d0dac3d733c", - "type": "Microsoft.ApiManagement/service/tenant/operationResults", "name": "6074e652093a9d0dac3d733c", + "type": "Microsoft.ApiManagement/service/tenant/operationResults", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.ApiManagement/service/apimService1", "properties": { - "status": "Succeeded", - "started": "2023-04-13T00:31:14.94Z", - "updated": "2023-04-13T00:31:27.59Z", + "actionLog": [], "resultInfo": "All the policies were validated", - "actionLog": [] + "started": "2023-04-13T00:31:14.94Z", + "status": "Succeeded", + "updated": "2023-04-13T00:31:27.59Z" } } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ApiManagement/service/apimService1/validatePolicies?api-version=2023-05-01" + } } - } + }, + "operationId": "PolicyRestrictionValidations_ByService", + "title": "ApiManagementListPolicyRestrictions" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceNamedValueListValue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceNamedValueListValue.json index 4980fb09f13f..6e4993e2e805 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceNamedValueListValue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceNamedValueListValue.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "namedValueId": "testarmTemplateproperties2", + "resourceGroupName": "rg1", + "serviceName": "apimService1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "namedValueId": "testarmTemplateproperties2" + "workspaceId": "wks1" }, "responses": { "200": { @@ -13,5 +13,7 @@ "value": "propValue" } } - } + }, + "operationId": "WorkspaceNamedValue_ListValue", + "title": "ApiManagementWorkspaceNamedValueListValue" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceSubscriptionListSecrets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceSubscriptionListSecrets.json index b537b2a2b42b..b6560433bb86 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceSubscriptionListSecrets.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceSubscriptionListSecrets.json @@ -1,11 +1,11 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "5931a769d8d14f0ad8ce13b8", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "sid": "5931a769d8d14f0ad8ce13b8" + "workspaceId": "wks1" }, "responses": { "200": { @@ -14,5 +14,7 @@ "secondaryKey": "" } } - } + }, + "operationId": "WorkspaceSubscription_ListSecrets", + "title": "ApiManagementWorkspaceSubscriptionListSecrets" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey.json index 87458ec6ff7f..1c72d1b9ca75 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey.json @@ -1,13 +1,15 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "sid": "testsub" + "workspaceId": "wks1" }, "responses": { "204": {} - } + }, + "operationId": "WorkspaceSubscription_RegeneratePrimaryKey", + "title": "ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey.json index 87458ec6ff7f..87b99d926e16 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/examples/ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey.json @@ -1,13 +1,15 @@ { "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", "api-version": "2024-10-01-preview", + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "sid": "testsub", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "workspaceId": "wks1", - "sid": "testsub" + "workspaceId": "wks1" }, "responses": { "204": {} - } + }, + "operationId": "WorkspaceSubscription_RegenerateSecondaryKey", + "title": "ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/openapi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/openapi.json new file mode 100644 index 000000000000..a2ac7ed32089 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/openapi.json @@ -0,0 +1,64174 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "version": "2024-10-01-preview", + "description": "Resource provider operation status.", + "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": "ApiManagementOperations" + }, + { + "name": "Operations" + }, + { + "name": "ApiManagementGatewayResources" + }, + { + "name": "ApiContracts" + }, + { + "name": "WorkspaceApi" + }, + { + "name": "ApiManagementServiceResources" + }, + { + "name": "ApiReleaseContracts" + }, + { + "name": "WorkspaceApiRelease" + }, + { + "name": "OperationContracts" + }, + { + "name": "WorkspaceApiOperation" + }, + { + "name": "PolicyContracts" + }, + { + "name": "GraphQLApiResolverPolicy" + }, + { + "name": "ApiPolicy" + }, + { + "name": "Policy" + }, + { + "name": "ProductPolicy" + }, + { + "name": "WorkspacePolicy" + }, + { + "name": "WorkspaceApiOperationPolicy" + }, + { + "name": "WorkspaceApiPolicy" + }, + { + "name": "WorkspaceProductPolicy" + }, + { + "name": "Tag" + }, + { + "name": "TagContracts" + }, + { + "name": "TagContractOperation" + }, + { + "name": "TagContractOperationGroup" + }, + { + "name": "WorkspaceTag" + }, + { + "name": "ResolverContracts" + }, + { + "name": "SchemaContracts" + }, + { + "name": "WorkspaceApiSchema" + }, + { + "name": "DiagnosticContracts" + }, + { + "name": "Diagnostic" + }, + { + "name": "WorkspaceDiagnostic" + }, + { + "name": "WorkspaceApiDiagnostic" + }, + { + "name": "IssueContracts" + }, + { + "name": "Issue" + }, + { + "name": "IssueCommentContracts" + }, + { + "name": "IssueAttachmentContracts" + }, + { + "name": "TagDescriptionContracts" + }, + { + "name": "WikiContracts" + }, + { + "name": "ProductWiki" + }, + { + "name": "ApiVersionSetContracts" + }, + { + "name": "WorkspaceApiVersionSet" + }, + { + "name": "AuthorizationProviderContracts" + }, + { + "name": "AuthorizationContracts" + }, + { + "name": "AuthorizationAccessPolicyContracts" + }, + { + "name": "AuthorizationServerContracts" + }, + { + "name": "BackendContracts" + }, + { + "name": "WorkspaceBackend" + }, + { + "name": "CacheContracts" + }, + { + "name": "CertificateContracts" + }, + { + "name": "WorkspaceCertificate" + }, + { + "name": "ContentTypeContracts" + }, + { + "name": "ContentItemContracts" + }, + { + "name": "DeletedServiceContracts" + }, + { + "name": "DocumentationContracts" + }, + { + "name": "EmailTemplateContracts" + }, + { + "name": "ApiManagementGatewayConfigConnectionResources" + }, + { + "name": "GatewayContracts" + }, + { + "name": "GatewayHostnameConfigurationContracts" + }, + { + "name": "GatewayCertificateAuthorityContracts" + }, + { + "name": "GroupContracts" + }, + { + "name": "WorkspaceGroup" + }, + { + "name": "IdentityProviderContracts" + }, + { + "name": "LoggerContracts" + }, + { + "name": "WorkspaceLogger" + }, + { + "name": "NamedValueContracts" + }, + { + "name": "WorkspaceNamedValue" + }, + { + "name": "NotificationContracts" + }, + { + "name": "WorkspaceNotification" + }, + { + "name": "OpenidConnectProviderContracts" + }, + { + "name": "PolicyFragmentContracts" + }, + { + "name": "WorkspacePolicyFragment" + }, + { + "name": "PolicyRestrictionContracts" + }, + { + "name": "PortalConfigContracts" + }, + { + "name": "ClientApplicationContracts" + }, + { + "name": "ClientApplicationProductLinkContracts" + }, + { + "name": "PortalRevisionContracts" + }, + { + "name": "SignInSettings" + }, + { + "name": "SignUpSettings" + }, + { + "name": "DelegationSettings" + }, + { + "name": "PrivateEndpointConnections" + }, + { + "name": "PrivateLinkResources" + }, + { + "name": "ProductContracts" + }, + { + "name": "WorkspaceProduct" + }, + { + "name": "ProductApiLinkContracts" + }, + { + "name": "WorkspaceProductApiLink" + }, + { + "name": "ProductGroupLinkContracts" + }, + { + "name": "WorkspaceProductGroupLink" + }, + { + "name": "GlobalSchemaContracts" + }, + { + "name": "WorkspaceGlobalSchema" + }, + { + "name": "TenantSettingsContracts" + }, + { + "name": "SubscriptionContracts" + }, + { + "name": "UserSubscription" + }, + { + "name": "WorkspaceSubscription" + }, + { + "name": "TagApiLinkContracts" + }, + { + "name": "WorkspaceTagApiLink" + }, + { + "name": "TagOperationLinkContracts" + }, + { + "name": "WorkspaceTagOperationLink" + }, + { + "name": "TagProductLinkContracts" + }, + { + "name": "WorkspaceTagProductLink" + }, + { + "name": "AccessInformationContracts" + }, + { + "name": "UserContracts" + }, + { + "name": "ApiManagementWorkspaceLinksResources" + }, + { + "name": "WorkspaceContracts" + } + ], + "paths": { + "/providers/Microsoft.ApiManagement/operations": { + "get": { + "operationId": "ApiManagementOperations_List", + "tags": [ + "ApiManagementOperations", + "Operations" + ], + "description": "Lists all of the available REST API operations of the Microsoft.ApiManagement provider.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListOperations": { + "$ref": "./examples/ApiManagementListOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/checkNameAvailability": { + "post": { + "operationId": "ApiManagementService_CheckNameAvailability", + "description": "Checks availability and correctness of a name for an API Management service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceCheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceNameAvailabilityResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementServiceCheckNameAvailability": { + "$ref": "./examples/ApiManagementServiceCheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/deletedservices": { + "get": { + "operationId": "DeletedServices_ListBySubscription", + "description": "Lists all soft-deleted services available for undelete for the 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": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeletedServicesCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementDeletedServicesListBySubscription": { + "$ref": "./examples/ApiManagementDeletedServicesListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/gateways": { + "get": { + "operationId": "ApiGateway_List", + "tags": [ + "ApiManagementGatewayResources" + ], + "description": "List all API Management gateways 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/ApiManagementGatewayListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListGatewaysBySubscription": { + "$ref": "./examples/ApiManagementListGatewaysBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/getDomainOwnershipIdentifier": { + "post": { + "operationId": "ApiManagementService_GetDomainOwnershipIdentifier", + "description": "Get the custom domain ownership identifier for an API Management service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceGetDomainOwnershipIdentifierResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementServiceGetDomainOwnershipIdentifier": { + "$ref": "./examples/ApiManagementServiceGetDomainOwnershipIdentifier.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/deletedservices/{serviceName}": { + "get": { + "operationId": "DeletedServices_GetByName", + "tags": [ + "DeletedServiceContracts" + ], + "description": "Get soft-deleted Api Management Service by 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/LocationParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeletedServiceContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetDeletedServiceByName": { + "$ref": "./examples/ApiManagementGetDeletedServiceByName.json" + } + } + }, + "delete": { + "operationId": "DeletedServices_Purge", + "tags": [ + "DeletedServiceContracts" + ], + "description": "Purges Api Management Service (deletes it with no option to undelete).", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/DeletedServiceContract" + }, + "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": "Location header" + } + } + }, + "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": { + "ApiManagementDeletedServicesPurge": { + "$ref": "./examples/ApiManagementDeletedServicesPurge.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/operationResults/{operationId}": { + "get": { + "operationId": "OperationsResults_Get", + "description": "Returns operation results for long running operations executing DELETE or PATCH on the 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/LocationParameter" + }, + { + "name": "operationId", + "in": "path", + "description": "The ID of an ongoing async operation.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetOperationResult": { + "$ref": "./examples/ApiManagementGetOperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/operationStatuses/{operationId}": { + "get": { + "operationId": "OperationStatus_Get", + "description": "Returns the current status of an async operation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "operationId", + "in": "path", + "description": "The ID of an ongoing async operation.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get operation status": { + "$ref": "./examples/ApiManagementGetOperationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/service": { + "get": { + "operationId": "ApiManagementService_List", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists all API Management services within an Azure 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/ApiManagementServiceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListServiceBySubscription": { + "$ref": "./examples/ApiManagementListServiceBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/skus": { + "get": { + "operationId": "ApiManagementSkus_List", + "description": "Gets the list of Microsoft.ApiManagement SKUs available for your 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/ApiManagementSkusResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists all available Resource SKUs": { + "$ref": "./examples/ApiManagementListSku.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways": { + "get": { + "operationId": "ApiGateway_ListByResourceGroup", + "tags": [ + "ApiManagementGatewayResources" + ], + "description": "List all API Management gateways 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/ApiManagementGatewayListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListGatewaysBySubscriptionAndResourceGroup": { + "$ref": "./examples/ApiManagementListGatewaysBySubscriptionAndResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}": { + "get": { + "operationId": "ApiGateway_Get", + "tags": [ + "ApiManagementGatewayResources" + ], + "description": "Gets an API Management gateway resource description.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the API Management gateway.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 45, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGatewayGetGateway": { + "$ref": "./examples/ApiManagementGatewayGetGateway.json" + } + } + }, + "put": { + "operationId": "ApiGateway_CreateOrUpdate", + "tags": [ + "ApiManagementGatewayResources" + ], + "description": "Creates or updates an API Management gateway. This is long running operation and could take several minutes to complete.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the API Management gateway.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 45, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the CreateOrUpdate API Management gateway operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementGatewayResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ApiManagementGatewayResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayResource" + } + }, + "201": { + "description": "Resource 'ApiManagementGatewayResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayResource" + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateStandardGateway": { + "$ref": "./examples/ApiManagementCreateStandardGateway.json" + }, + "ApiManagementCreateWorkspacePremiumGateway": { + "$ref": "./examples/ApiManagementCreateWorkspacePremiumGateway.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/ApiManagementGatewayResource" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ApiGateway_Update", + "tags": [ + "ApiManagementGatewayResources" + ], + "description": "Updates an existing API Management gateway.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the API Management gateway.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 45, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the CreateOrUpdate API Management gateway operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementGatewayUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayResource" + } + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateStandardGateway": { + "$ref": "./examples/ApiManagementUpdateStandardGateway.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/ApiManagementGatewayResource" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ApiGateway_Delete", + "tags": [ + "ApiManagementGatewayResources" + ], + "description": "Deletes an existing API Management gateway.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the API Management gateway.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 45, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayResource" + }, + "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": "Location header" + } + } + }, + "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": { + "ApiManagementGatewayDeleteGateway": { + "$ref": "./examples/ApiManagementGatewayDeleteGateway.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections": { + "get": { + "operationId": "ApiGatewayConfigConnection_ListByGateway", + "tags": [ + "ApiManagementGatewayConfigConnectionResources" + ], + "description": "List all API Management gateway config connections within a gateway.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the API Management gateway.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 45, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayConfigConnectionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListGatewayConfigConnection": { + "$ref": "./examples/ApiManagementListGatewayConfigConnection.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections/{configConnectionName}": { + "get": { + "operationId": "ApiGatewayConfigConnection_Get", + "tags": [ + "ApiManagementGatewayConfigConnectionResources" + ], + "description": "Gets an API Management gateway config connection resource description.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the API Management gateway.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 45, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "configConnectionName", + "in": "path", + "description": "The name of the API Management gateway config connection.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetGatewayConfigConnection": { + "$ref": "./examples/ApiManagementGetGatewayConfigConnection.json" + } + } + }, + "put": { + "operationId": "ApiGatewayConfigConnection_CreateOrUpdate", + "tags": [ + "ApiManagementGatewayConfigConnectionResources" + ], + "description": "Creates or updates an API Management gateway config connection. This is long running operation and could take several minutes to complete.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the API Management gateway.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 45, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "configConnectionName", + "in": "path", + "description": "The name of the API Management gateway config connection.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the CreateOrUpdate API Management gateway config connection operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ApiManagementGatewayConfigConnectionResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" + } + }, + "201": { + "description": "Resource 'ApiManagementGatewayConfigConnectionResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" + }, + "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": { + "ApiManagementCreateGatewayConfigConnection": { + "$ref": "./examples/ApiManagementCreateGatewayConfigConnection.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation", + "final-state-schema": "#/definitions/ApiManagementGatewayConfigConnectionResource" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ApiGatewayConfigConnection_Delete", + "tags": [ + "ApiManagementGatewayConfigConnectionResources" + ], + "description": "Deletes an existing API Management gateway config 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": "gatewayName", + "in": "path", + "description": "The name of the API Management gateway.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 45, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "configConnectionName", + "in": "path", + "description": "The name of the API Management gateway config connection.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 30, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "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": "Location header" + } + } + }, + "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": { + "ApiManagementGatewayDeleteGateway": { + "$ref": "./examples/ApiManagementDeleteGatewayConfigConnection.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/skus": { + "get": { + "operationId": "ApiManagementGatewaySkus_ListAvailableSkus", + "tags": [ + "ApiManagementGatewayResources" + ], + "summary": "Gets available SKUs for API Management gateway", + "description": "Gets all available SKU for a given API Management gateway", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the API Management gateway.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 45, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GatewayResourceSkuResults" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListSKUs-Gateways": { + "$ref": "./examples/ApiManagementListSKUs-Gateways.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service": { + "get": { + "operationId": "ApiManagementService_ListByResourceGroup", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "List all API Management services 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/ApiManagementServiceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListServiceBySubscriptionAndResourceGroup": { + "$ref": "./examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}": { + "get": { + "operationId": "ApiManagementService_Get", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Gets an API Management service resource description.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementServiceGetMultiRegionInternalVnet": { + "$ref": "./examples/ApiManagementServiceGetMultiRegionInternalVnet.json" + }, + "ApiManagementServiceGetService": { + "$ref": "./examples/ApiManagementServiceGetService.json" + }, + "ApiManagementServiceGetServiceHavingMsi": { + "$ref": "./examples/ApiManagementServiceGetServiceHavingMsi.json" + } + } + }, + "put": { + "operationId": "ApiManagementService_CreateOrUpdate", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Creates or updates an API Management service. This is long running operation and could take several minutes to complete.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the CreateOrUpdate API Management service operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ApiManagementServiceResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "201": { + "description": "Resource 'ApiManagementServiceResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateMultiRegionServiceWithCustomHostname": { + "$ref": "./examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json" + }, + "ApiManagementCreateService": { + "$ref": "./examples/ApiManagementCreateService.json" + }, + "ApiManagementCreateServiceHavingMsi": { + "$ref": "./examples/ApiManagementCreateServiceHavingMsi.json" + }, + "ApiManagementCreateServiceInVnetWithPublicIP": { + "$ref": "./examples/ApiManagementCreateServiceInVnetWithPublicIP.json" + }, + "ApiManagementCreateServiceInZones": { + "$ref": "./examples/ApiManagementCreateServiceInZones.json" + }, + "ApiManagementCreateServiceSkuv2Service": { + "$ref": "./examples/ApiManagementCreateServiceSkuv2Service.json" + }, + "ApiManagementCreateServiceWithCustomHostnameKeyVault": { + "$ref": "./examples/ApiManagementCreateServiceWithCustomHostnameKeyVault.json" + }, + "ApiManagementCreateServiceWithDeveloperPortal": { + "$ref": "./examples/ApiManagementCreateServiceWithDeveloperPortal.json" + }, + "ApiManagementCreateServiceWithNatGatewayEnabled": { + "$ref": "./examples/ApiManagementCreateServiceWithNatGatewayEnabled.json" + }, + "ApiManagementCreateServiceWithSystemCertificates": { + "$ref": "./examples/ApiManagementCreateServiceWithSystemCertificates.json" + }, + "ApiManagementCreateServiceWithUserAssignedIdentity": { + "$ref": "./examples/ApiManagementCreateServiceWithUserAssignedIdentity.json" + }, + "ApiManagementCreateServiceWithoutLegacyConfigurationApi": { + "$ref": "./examples/ApiManagementCreateServiceWithoutLegacyConfigurationApi.json" + }, + "ApiManagementUndelete": { + "$ref": "./examples/ApiManagementUndelete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/ApiManagementServiceResource" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ApiManagementService_Update", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Updates an existing API Management service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the CreateOrUpdate API Management service operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateServiceDisableTls10": { + "$ref": "./examples/ApiManagementUpdateServiceDisableTls10.json" + }, + "ApiManagementUpdateServicePublisherDetails": { + "$ref": "./examples/ApiManagementUpdateServicePublisherDetails.json" + }, + "ApiManagementUpdateServiceToNewVnetAndAvailabilityZones": { + "$ref": "./examples/ApiManagementUpdateServiceToNewVnetAndAZs.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/ApiManagementServiceResource" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ApiManagementService_Delete", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Deletes an existing API Management service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + }, + "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": "Location header" + } + } + }, + "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": { + "ApiManagementServiceDeleteService": { + "$ref": "./examples/ApiManagementServiceDeleteService.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/allPolicies": { + "get": { + "operationId": "AllPolicies_ListByService", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Status of all policies of API Management services.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AllPoliciesCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListPolicyRestrictions": { + "$ref": "./examples/ApiManagementAllPolicies.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets": { + "get": { + "operationId": "ApiVersionSet_ListByService", + "tags": [ + "ApiVersionSetContracts" + ], + "description": "Lists a collection of API Version Sets in the specified service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiVersionSetCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiVersionSets": { + "$ref": "./examples/ApiManagementListApiVersionSets.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}": { + "get": { + "operationId": "ApiVersionSet_Get", + "tags": [ + "ApiVersionSetContracts" + ], + "description": "Gets the details of the Api Version Set specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "versionSetId", + "in": "path", + "description": "Api Version Set identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiVersionSet": { + "$ref": "./examples/ApiManagementGetApiVersionSet.json" + } + } + }, + "put": { + "operationId": "ApiVersionSet_CreateOrUpdate", + "tags": [ + "ApiVersionSetContracts" + ], + "description": "Creates or Updates a Api Version Set.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "versionSetId", + "in": "path", + "description": "Api Version Set identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiVersionSetContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApiVersionSet": { + "$ref": "./examples/ApiManagementCreateApiVersionSet.json" + } + } + }, + "patch": { + "operationId": "ApiVersionSet_Update", + "tags": [ + "ApiVersionSetContracts" + ], + "description": "Updates the details of the Api VersionSet specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "versionSetId", + "in": "path", + "description": "Api Version Set identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiVersionSetUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateApiVersionSet": { + "$ref": "./examples/ApiManagementUpdateApiVersionSet.json" + } + } + }, + "delete": { + "operationId": "ApiVersionSet_Delete", + "tags": [ + "ApiVersionSetContracts" + ], + "description": "Deletes specific Api Version Set.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "versionSetId", + "in": "path", + "description": "Api Version Set identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteApiVersionSet": { + "$ref": "./examples/ApiManagementDeleteApiVersionSet.json" + } + } + }, + "head": { + "operationId": "ApiVersionSet_GetEntityTag", + "tags": [ + "ApiVersionSetContracts" + ], + "description": "Gets the entity state (Etag) version of the Api Version Set specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "versionSetId", + "in": "path", + "description": "Api Version Set identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApiVersionSet": { + "$ref": "./examples/ApiManagementHeadApiVersionSet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis": { + "get": { + "operationId": "Api_ListByService", + "tags": [ + "ApiContracts" + ], + "description": "Lists all APIs of the API Management service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-apis" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq, ne | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "tags", + "in": "query", + "description": "Include tags in the response.", + "required": false, + "type": "string" + }, + { + "name": "expandApiVersionSet", + "in": "query", + "description": "Include full ApiVersionSet resource in response", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApis": { + "$ref": "./examples/ApiManagementListApis.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}": { + "get": { + "operationId": "Api_Get", + "tags": [ + "ApiContracts" + ], + "description": "Gets the details of the API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiContract": { + "$ref": "./examples/ApiManagementGetApiContract.json" + }, + "ApiManagementGetApiRevisionContract": { + "$ref": "./examples/ApiManagementGetApiRevision.json" + } + } + }, + "put": { + "operationId": "Api_CreateOrUpdate", + "tags": [ + "ApiContracts" + ], + "description": "Creates new or updates existing specified API of the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiCreateOrUpdateParameter" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/ApiContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApi": { + "$ref": "./examples/ApiManagementCreateApi.json" + }, + "ApiManagementCreateApiClone": { + "$ref": "./examples/ApiManagementCreateApiClone.json" + }, + "ApiManagementCreateApiNewVersionUsingExistingApi": { + "$ref": "./examples/ApiManagementCreateApiNewVersionUsingExistingApi.json" + }, + "ApiManagementCreateApiRevisionFromExistingApi": { + "$ref": "./examples/ApiManagementCreateApiRevisionFromExistingApi.json" + }, + "ApiManagementCreateApiUsingImportOverrideServiceUrl": { + "$ref": "./examples/ApiManagementCreateApiUsingImportOverrideServiceUrl.json" + }, + "ApiManagementCreateApiUsingOai3Import": { + "$ref": "./examples/ApiManagementCreateApiUsingOai3Import.json" + }, + "ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct": { + "$ref": "./examples/ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct.json" + }, + "ApiManagementCreateApiUsingSwaggerImport": { + "$ref": "./examples/ApiManagementCreateApiUsingSwaggerImport.json" + }, + "ApiManagementCreateApiUsingWadlImport": { + "$ref": "./examples/ApiManagementCreateApiUsingWadlImport.json" + }, + "ApiManagementCreateApiWithMultipleAuthServers": { + "$ref": "./examples/ApiManagementCreateApiWithMultipleAuthServers.json" + }, + "ApiManagementCreateApiWithMultipleOpenIdConnectProviders": { + "$ref": "./examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json" + }, + "ApiManagementCreateApiWithOpenIdConnect": { + "$ref": "./examples/ApiManagementCreateApiWithOpenIdConnect.json" + }, + "ApiManagementCreateGraphQLApi": { + "$ref": "./examples/ApiManagementCreateGraphQLApi.json" + }, + "ApiManagementCreateGrpcApi": { + "$ref": "./examples/ApiManagementCreateGrpcApi.json" + }, + "ApiManagementCreateODataApi": { + "$ref": "./examples/ApiManagementCreateODataApi.json" + }, + "ApiManagementCreateSoapPassThroughApiUsingWsdlImport": { + "$ref": "./examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json" + }, + "ApiManagementCreateSoapToRestApiUsingWsdlImport": { + "$ref": "./examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json" + }, + "ApiManagementCreateWebSocketApi": { + "$ref": "./examples/ApiManagementCreateWebsocketApi.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/ApiContract" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Api_Update", + "tags": [ + "ApiContracts" + ], + "description": "Updates the specified API of the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "API Update Contract parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateApi": { + "$ref": "./examples/ApiManagementUpdateApi.json" + } + } + }, + "delete": { + "operationId": "Api_Delete", + "tags": [ + "ApiContracts" + ], + "description": "Deletes the specified API of the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "deleteRevisions", + "in": "query", + "description": "Delete all revisions of the Api.", + "required": false, + "type": "boolean" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "204": { + "description": "Operation completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementDeleteApi": { + "$ref": "./examples/ApiManagementDeleteApi.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "head": { + "operationId": "Api_GetEntityTag", + "tags": [ + "ApiContracts" + ], + "description": "Gets the entity state (Etag) version of the API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApi": { + "$ref": "./examples/ApiManagementHeadApi.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics": { + "get": { + "operationId": "ApiDiagnostic_ListByService", + "tags": [ + "DiagnosticContracts" + ], + "description": "Lists all diagnostics of an API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiagnosticCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiDiagnostics": { + "$ref": "./examples/ApiManagementListApiDiagnostics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}": { + "get": { + "operationId": "ApiDiagnostic_Get", + "tags": [ + "DiagnosticContracts" + ], + "description": "Gets the details of the Diagnostic for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiDiagnostic": { + "$ref": "./examples/ApiManagementGetApiDiagnostic.json" + } + } + }, + "put": { + "operationId": "ApiDiagnostic_CreateOrUpdate", + "tags": [ + "DiagnosticContracts" + ], + "description": "Creates a new Diagnostic for an API or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApiDiagnostic": { + "$ref": "./examples/ApiManagementCreateApiDiagnostic.json" + } + } + }, + "patch": { + "operationId": "ApiDiagnostic_Update", + "tags": [ + "DiagnosticContracts" + ], + "description": "Updates the details of the Diagnostic for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Diagnostic Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateApiDiagnostic": { + "$ref": "./examples/ApiManagementUpdateApiDiagnostic.json" + } + } + }, + "delete": { + "operationId": "ApiDiagnostic_Delete", + "tags": [ + "DiagnosticContracts" + ], + "description": "Deletes the specified Diagnostic from an API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteApiDiagnostic": { + "$ref": "./examples/ApiManagementDeleteApiDiagnostic.json" + } + } + }, + "head": { + "operationId": "ApiDiagnostic_GetEntityTag", + "tags": [ + "DiagnosticContracts" + ], + "description": "Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApiDiagnostic": { + "$ref": "./examples/ApiManagementHeadApiDiagnostic.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues": { + "get": { + "operationId": "ApiIssue_ListByService", + "tags": [ + "IssueContracts" + ], + "description": "Lists all issues associated with the specified API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
", + "required": false, + "type": "string" + }, + { + "name": "expandCommentsAttachments", + "in": "query", + "description": "Expand the comment attachments.", + "required": false, + "type": "boolean" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IssueCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiIssues": { + "$ref": "./examples/ApiManagementListApiIssues.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}": { + "get": { + "operationId": "ApiIssue_Get", + "tags": [ + "IssueContracts" + ], + "description": "Gets the details of the Issue for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "expandCommentsAttachments", + "in": "query", + "description": "Expand the comment attachments.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiIssue": { + "$ref": "./examples/ApiManagementGetApiIssue.json" + } + } + }, + "put": { + "operationId": "ApiIssue_CreateOrUpdate", + "tags": [ + "IssueContracts" + ], + "description": "Creates a new Issue for an API or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IssueContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApiIssue": { + "$ref": "./examples/ApiManagementCreateApiIssue.json" + } + } + }, + "patch": { + "operationId": "ApiIssue_Update", + "tags": [ + "IssueContracts" + ], + "description": "Updates an existing issue for an API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IssueUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateApiIssue": { + "$ref": "./examples/ApiManagementUpdateApiIssue.json" + } + } + }, + "delete": { + "operationId": "ApiIssue_Delete", + "tags": [ + "IssueContracts" + ], + "description": "Deletes the specified Issue from an API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteApiIssue": { + "$ref": "./examples/ApiManagementDeleteApiIssue.json" + } + } + }, + "head": { + "operationId": "ApiIssue_GetEntityTag", + "tags": [ + "IssueContracts" + ], + "description": "Gets the entity state (Etag) version of the Issue for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApiIssue": { + "$ref": "./examples/ApiManagementHeadApiIssue.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments": { + "get": { + "operationId": "ApiIssueAttachment_ListByService", + "tags": [ + "IssueAttachmentContracts" + ], + "description": "Lists all attachments for the Issue associated with the specified API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IssueAttachmentCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiIssueAttachments": { + "$ref": "./examples/ApiManagementListApiIssueAttachments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments/{attachmentId}": { + "get": { + "operationId": "ApiIssueAttachment_Get", + "tags": [ + "IssueAttachmentContracts" + ], + "description": "Gets the details of the issue Attachment for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "attachmentId", + "in": "path", + "description": "Attachment identifier within an Issue. Must be unique in the current Issue.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/IssueAttachmentContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiIssueAttachment": { + "$ref": "./examples/ApiManagementGetApiIssueAttachment.json" + } + } + }, + "put": { + "operationId": "ApiIssueAttachment_CreateOrUpdate", + "tags": [ + "IssueAttachmentContracts" + ], + "description": "Creates a new Attachment for the Issue in an API or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "attachmentId", + "in": "path", + "description": "Attachment identifier within an Issue. Must be unique in the current Issue.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IssueAttachmentContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/IssueAttachmentContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/IssueAttachmentContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApiIssueAttachment": { + "$ref": "./examples/ApiManagementCreateApiIssueAttachment.json" + } + } + }, + "delete": { + "operationId": "ApiIssueAttachment_Delete", + "tags": [ + "IssueAttachmentContracts" + ], + "description": "Deletes the specified comment from an Issue.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "attachmentId", + "in": "path", + "description": "Attachment identifier within an Issue. Must be unique in the current Issue.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteApiIssueAttachment": { + "$ref": "./examples/ApiManagementDeleteApiIssueAttachment.json" + } + } + }, + "head": { + "operationId": "ApiIssueAttachment_GetEntityTag", + "tags": [ + "IssueAttachmentContracts" + ], + "description": "Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "attachmentId", + "in": "path", + "description": "Attachment identifier within an Issue. Must be unique in the current Issue.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApiIssueAttachment": { + "$ref": "./examples/ApiManagementHeadApiIssueAttachment.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments": { + "get": { + "operationId": "ApiIssueComment_ListByService", + "tags": [ + "IssueCommentContracts" + ], + "description": "Lists all comments for the Issue associated with the specified API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IssueCommentCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiIssueComments": { + "$ref": "./examples/ApiManagementListApiIssueComments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}": { + "get": { + "operationId": "ApiIssueComment_Get", + "tags": [ + "IssueCommentContracts" + ], + "description": "Gets the details of the issue Comment for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "commentId", + "in": "path", + "description": "Comment identifier within an Issue. Must be unique in the current Issue.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/IssueCommentContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiIssueComment": { + "$ref": "./examples/ApiManagementGetApiIssueComment.json" + } + } + }, + "put": { + "operationId": "ApiIssueComment_CreateOrUpdate", + "tags": [ + "IssueCommentContracts" + ], + "description": "Creates a new Comment for the Issue in an API or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "commentId", + "in": "path", + "description": "Comment identifier within an Issue. Must be unique in the current Issue.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IssueCommentContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/IssueCommentContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/IssueCommentContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApiIssueComment": { + "$ref": "./examples/ApiManagementCreateApiIssueComment.json" + } + } + }, + "delete": { + "operationId": "ApiIssueComment_Delete", + "tags": [ + "IssueCommentContracts" + ], + "description": "Deletes the specified comment from an Issue.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "commentId", + "in": "path", + "description": "Comment identifier within an Issue. Must be unique in the current Issue.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteApiIssueComment": { + "$ref": "./examples/ApiManagementDeleteApiIssueComment.json" + } + } + }, + "head": { + "operationId": "ApiIssueComment_GetEntityTag", + "tags": [ + "IssueCommentContracts" + ], + "description": "Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "commentId", + "in": "path", + "description": "Comment identifier within an Issue. Must be unique in the current Issue.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApiIssueComment": { + "$ref": "./examples/ApiManagementHeadApiIssueComment.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations": { + "get": { + "operationId": "ApiOperation_ListByApi", + "tags": [ + "OperationContracts" + ], + "description": "Lists a collection of the operations for the specified API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "tags", + "in": "query", + "description": "Include tags in the response.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiOperations": { + "$ref": "./examples/ApiManagementListApiOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}": { + "get": { + "operationId": "ApiOperation_Get", + "tags": [ + "OperationContracts" + ], + "description": "Gets the details of the API Operation specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiOperation": { + "$ref": "./examples/ApiManagementGetApiOperation.json" + }, + "ApiManagementGetApiOperationPetStore": { + "$ref": "./examples/ApiManagementGetApiOperationPetStore.json" + } + } + }, + "put": { + "operationId": "ApiOperation_CreateOrUpdate", + "tags": [ + "OperationContracts" + ], + "description": "Creates a new operation in the API or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OperationContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApiOperation": { + "$ref": "./examples/ApiManagementCreateApiOperation.json" + } + } + }, + "patch": { + "operationId": "ApiOperation_Update", + "tags": [ + "OperationContracts" + ], + "description": "Updates the details of the operation in the API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "API Operation Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OperationUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateApiOperation": { + "$ref": "./examples/ApiManagementUpdateApiOperation.json" + } + } + }, + "delete": { + "operationId": "ApiOperation_Delete", + "tags": [ + "OperationContracts" + ], + "description": "Deletes the specified operation in the API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteApiOperation": { + "$ref": "./examples/ApiManagementDeleteApiOperation.json" + } + } + }, + "head": { + "operationId": "ApiOperation_GetEntityTag", + "tags": [ + "OperationContracts" + ], + "description": "Gets the entity state (Etag) version of the API operation specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApiOperation": { + "$ref": "./examples/ApiManagementHeadApiOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies": { + "get": { + "operationId": "ApiOperationPolicy_ListByOperation", + "tags": [ + "PolicyContracts" + ], + "description": "Get the list of policy configuration at the API Operation level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PolicyCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiOperationPolicies": { + "$ref": "./examples/ApiManagementListApiOperationPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/{policyId}": { + "get": { + "operationId": "ApiOperationPolicy_Get", + "tags": [ + "PolicyContracts" + ], + "description": "Get the policy configuration at the API Operation level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "format", + "in": "query", + "description": "Policy Export Format.", + "required": false, + "type": "string", + "default": "xml", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyExportFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiOperationPolicy": { + "$ref": "./examples/ApiManagementGetApiOperationPolicy.json" + } + } + }, + "put": { + "operationId": "ApiOperationPolicy_CreateOrUpdate", + "tags": [ + "PolicyContracts" + ], + "description": "Creates or updates policy configuration for the API Operation level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The policy contents to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApiOperationPolicy": { + "$ref": "./examples/ApiManagementCreateApiOperationPolicy.json" + } + } + }, + "delete": { + "operationId": "ApiOperationPolicy_Delete", + "tags": [ + "PolicyContracts" + ], + "description": "Deletes the policy configuration at the Api Operation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteApiOperationPolicy": { + "$ref": "./examples/ApiManagementDeleteApiOperationPolicy.json" + } + } + }, + "head": { + "operationId": "ApiOperationPolicy_GetEntityTag", + "tags": [ + "PolicyContracts" + ], + "description": "Gets the entity state (Etag) version of the API operation policy specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApiOperationPolicy": { + "$ref": "./examples/ApiManagementHeadApiOperationPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags": { + "get": { + "operationId": "Tag_ListByOperation", + "tags": [ + "TagContracts" + ], + "description": "Lists all Tags associated with the Operation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiOperationTags": { + "$ref": "./examples/ApiManagementListApiOperationTags.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}": { + "get": { + "operationId": "Tag_GetByOperation", + "tags": [ + "TagContracts" + ], + "description": "Get tag associated with the Operation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiOperationTag": { + "$ref": "./examples/ApiManagementGetApiOperationTag.json" + } + } + }, + "put": { + "operationId": "Tag_AssignToOperation", + "tags": [ + "TagContracts" + ], + "description": "Assign tag to the Operation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource 'TagContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "201": { + "description": "Resource 'TagContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApiOperationTag": { + "$ref": "./examples/ApiManagementCreateApiOperationTag.json" + } + } + }, + "delete": { + "operationId": "Tag_DetachFromOperation", + "tags": [ + "TagContracts" + ], + "description": "Detach the tag from the Operation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteApiOperationTag": { + "$ref": "./examples/ApiManagementDeleteApiOperationTag.json" + } + } + }, + "head": { + "operationId": "Tag_GetEntityStateByOperation", + "tags": [ + "TagContracts" + ], + "description": "Gets the entity state version of the tag specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApiOperationTag": { + "$ref": "./examples/ApiManagementHeadApiOperationTag.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags": { + "get": { + "operationId": "Operation_ListByTags", + "tags": [ + "ApiContracts" + ], + "description": "Lists a collection of operations associated with 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": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "includeNotTaggedOperations", + "in": "query", + "description": "Include not tagged Operations.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagResourceCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiOperationsByTags": { + "$ref": "./examples/ApiManagementListApiOperationsByTags.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies": { + "get": { + "operationId": "ApiPolicy_ListByApi", + "tags": [ + "ApiPolicy" + ], + "description": "Get the policy configuration at the API level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PolicyCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiPolicies": { + "$ref": "./examples/ApiManagementListApiPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}": { + "get": { + "operationId": "ApiPolicy_Get", + "tags": [ + "ApiPolicy" + ], + "description": "Get the policy configuration at the API level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "format", + "in": "query", + "description": "Policy Export Format.", + "required": false, + "type": "string", + "default": "xml", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyExportFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiPolicy": { + "$ref": "./examples/ApiManagementGetApiPolicy.json" + } + } + }, + "put": { + "operationId": "ApiPolicy_CreateOrUpdate", + "tags": [ + "ApiPolicy" + ], + "description": "Creates or updates policy configuration for the API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The policy contents to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApiPolicy": { + "$ref": "./examples/ApiManagementCreateApiPolicy.json" + }, + "ApiManagementCreateApiPolicyNonXmlEncoded": { + "$ref": "./examples/ApiManagementCreateApiPolicyNonXmlEncoded.json" + } + } + }, + "delete": { + "operationId": "ApiPolicy_Delete", + "tags": [ + "ApiPolicy" + ], + "description": "Deletes the policy configuration at the Api.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteApiPolicy": { + "$ref": "./examples/ApiManagementDeleteApiPolicy.json" + } + } + }, + "head": { + "operationId": "ApiPolicy_GetEntityTag", + "tags": [ + "ApiPolicy" + ], + "description": "Gets the entity state (Etag) version of the API policy specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApiPolicy": { + "$ref": "./examples/ApiManagementHeadApiPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products": { + "get": { + "operationId": "ApiProduct_ListByApis", + "tags": [ + "ApiContracts" + ], + "description": "Lists all Products, which the API is part of.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProductCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiProducts": { + "$ref": "./examples/ApiManagementListApiProducts.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases": { + "get": { + "operationId": "ApiRelease_ListByService", + "tags": [ + "ApiReleaseContracts" + ], + "description": "Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| notes | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiReleaseCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiReleases": { + "$ref": "./examples/ApiManagementListApiReleases.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}": { + "get": { + "operationId": "ApiRelease_Get", + "tags": [ + "ApiReleaseContracts" + ], + "description": "Returns the details of an API release.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "releaseId", + "in": "path", + "description": "Release identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiRelease": { + "$ref": "./examples/ApiManagementGetApiRelease.json" + } + } + }, + "put": { + "operationId": "ApiRelease_CreateOrUpdate", + "tags": [ + "ApiReleaseContracts" + ], + "description": "Creates a new Release for the API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "releaseId", + "in": "path", + "description": "Release identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApiRelease": { + "$ref": "./examples/ApiManagementCreateApiRelease.json" + } + } + }, + "patch": { + "operationId": "ApiRelease_Update", + "tags": [ + "ApiReleaseContracts" + ], + "description": "Updates the details of the release of the API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "releaseId", + "in": "path", + "description": "Release identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "API Release Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateApiRelease": { + "$ref": "./examples/ApiManagementUpdateApiRelease.json" + } + } + }, + "delete": { + "operationId": "ApiRelease_Delete", + "tags": [ + "ApiReleaseContracts" + ], + "description": "Deletes the specified release in the API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "releaseId", + "in": "path", + "description": "Release identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteApiRelease": { + "$ref": "./examples/ApiManagementDeleteApiRelease.json" + } + } + }, + "head": { + "operationId": "ApiRelease_GetEntityTag", + "tags": [ + "ApiReleaseContracts" + ], + "description": "Returns the etag of an API release.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "releaseId", + "in": "path", + "description": "Release identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApiRelease": { + "$ref": "./examples/ApiManagementHeadApiRelease.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers": { + "get": { + "operationId": "GraphQLApiResolver_ListByApi", + "tags": [ + "ResolverContracts" + ], + "description": "Lists a collection of the resolvers for the specified GraphQL API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ResolverCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListGraphQLApiResolvers": { + "$ref": "./examples/ApiManagementListGraphQLApiResolvers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}": { + "get": { + "operationId": "GraphQLApiResolver_Get", + "tags": [ + "ResolverContracts" + ], + "description": "Gets the details of the GraphQL API Resolver specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "resolverId", + "in": "path", + "description": "Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResolverContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetGraphQLApiResolver": { + "$ref": "./examples/ApiManagementGetGraphQLApiResolver.json" + } + } + }, + "put": { + "operationId": "GraphQLApiResolver_CreateOrUpdate", + "tags": [ + "ResolverContracts" + ], + "description": "Creates a new resolver in the GraphQL API or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "resolverId", + "in": "path", + "description": "Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ResolverContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResolverContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/ResolverContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateGraphQLApiResolver": { + "$ref": "./examples/ApiManagementCreateGraphQLApiResolver.json" + } + } + }, + "patch": { + "operationId": "GraphQLApiResolver_Update", + "tags": [ + "ResolverContracts" + ], + "description": "Updates the details of the resolver in the GraphQL API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "resolverId", + "in": "path", + "description": "Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "GraphQL API Resolver Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ResolverUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResolverContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateGraphQLApiResolver": { + "$ref": "./examples/ApiManagementUpdateGraphQLApiResolver.json" + } + } + }, + "delete": { + "operationId": "GraphQLApiResolver_Delete", + "tags": [ + "ResolverContracts" + ], + "description": "Deletes the specified resolver in the GraphQL API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "resolverId", + "in": "path", + "description": "Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteGraphQLApiResolver": { + "$ref": "./examples/ApiManagementDeleteGraphQLApiResolver.json" + } + } + }, + "head": { + "operationId": "GraphQLApiResolver_GetEntityTag", + "tags": [ + "ResolverContracts" + ], + "description": "Gets the entity state (Etag) version of the GraphQL API resolver specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "resolverId", + "in": "path", + "description": "Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadGraphQLApiResolver": { + "$ref": "./examples/ApiManagementHeadGraphQLApiResolver.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}/policies": { + "get": { + "operationId": "GraphQLApiResolverPolicy_ListByResolver", + "tags": [ + "GraphQLApiResolverPolicy" + ], + "description": "Get the list of policy configuration at the GraphQL API Resolver level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "resolverId", + "in": "path", + "description": "Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PolicyCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListGraphQLApiResolverPolicies": { + "$ref": "./examples/ApiManagementListGraphQLApiResolverPolicies.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}/policies/{policyId}": { + "get": { + "operationId": "GraphQLApiResolverPolicy_Get", + "tags": [ + "GraphQLApiResolverPolicy" + ], + "description": "Get the policy configuration at the GraphQL API Resolver level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "resolverId", + "in": "path", + "description": "Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "format", + "in": "query", + "description": "Policy Export Format.", + "required": false, + "type": "string", + "default": "xml", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyExportFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetGraphQLApiResolverPolicy": { + "$ref": "./examples/ApiManagementGetGraphQLApiResolverPolicy.json" + } + } + }, + "put": { + "operationId": "GraphQLApiResolverPolicy_CreateOrUpdate", + "tags": [ + "GraphQLApiResolverPolicy" + ], + "description": "Creates or updates policy configuration for the GraphQL API Resolver level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "resolverId", + "in": "path", + "description": "Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The policy contents to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateGraphQLApiResolverPolicy": { + "$ref": "./examples/ApiManagementCreateGraphQLApiResolverPolicy.json" + } + } + }, + "delete": { + "operationId": "GraphQLApiResolverPolicy_Delete", + "tags": [ + "GraphQLApiResolverPolicy" + ], + "description": "Deletes the policy configuration at the GraphQL Api Resolver.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "resolverId", + "in": "path", + "description": "Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteGraphQLApiResolverPolicy": { + "$ref": "./examples/ApiManagementDeleteGraphQLApiResolverPolicy.json" + } + } + }, + "head": { + "operationId": "GraphQLApiResolverPolicy_GetEntityTag", + "tags": [ + "GraphQLApiResolverPolicy" + ], + "description": "Gets the entity state (Etag) version of the GraphQL API resolver policy specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "resolverId", + "in": "path", + "description": "Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadGraphQLApiResolverPolicy": { + "$ref": "./examples/ApiManagementHeadGraphQLApiResolverPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/revisions": { + "get": { + "operationId": "ApiRevision_ListByService", + "tags": [ + "ApiContracts" + ], + "description": "Lists all revisions of an API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiRevisionCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiRevisions": { + "$ref": "./examples/ApiManagementListApiRevisions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas": { + "get": { + "operationId": "ApiSchema_ListByApi", + "tags": [ + "SchemaContracts" + ], + "description": "Get the schema configuration at the API level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SchemaCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiSchemas": { + "$ref": "./examples/ApiManagementListApiSchemas.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}": { + "get": { + "operationId": "ApiSchema_Get", + "tags": [ + "SchemaContracts" + ], + "description": "Get the schema configuration at the API level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SchemaContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiSchema": { + "$ref": "./examples/ApiManagementGetApiSchema.json" + } + } + }, + "put": { + "operationId": "ApiSchema_CreateOrUpdate", + "tags": [ + "SchemaContracts" + ], + "description": "Creates or updates schema configuration for the API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The schema contents to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/SchemaContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SchemaContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/SchemaContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApiSchema": { + "$ref": "./examples/ApiManagementCreateApiSchema.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/SchemaContract" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ApiSchema_Delete", + "tags": [ + "SchemaContracts" + ], + "description": "Deletes the schema configuration at the Api.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "force", + "in": "query", + "description": "If true removes all references to the schema before deleting it.", + "required": false, + "type": "boolean" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteApiSchema": { + "$ref": "./examples/ApiManagementDeleteApiSchema.json" + } + } + }, + "head": { + "operationId": "ApiSchema_GetEntityTag", + "tags": [ + "SchemaContracts" + ], + "description": "Gets the entity state (Etag) version of the schema specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApiSchema": { + "$ref": "./examples/ApiManagementHeadApiSchema.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions": { + "get": { + "operationId": "ApiTagDescription_ListByService", + "tags": [ + "TagDescriptionContracts" + ], + "description": "Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagDescriptionCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiTagDescriptions": { + "$ref": "./examples/ApiManagementListApiTagDescriptions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}": { + "get": { + "operationId": "ApiTagDescription_Get", + "tags": [ + "TagDescriptionContracts" + ], + "description": "Get Tag description in scope of API", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagDescriptionId", + "in": "path", + "description": "Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagDescriptionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiTagDescription": { + "$ref": "./examples/ApiManagementGetApiTagDescription.json" + } + } + }, + "put": { + "operationId": "ApiTagDescription_CreateOrUpdate", + "tags": [ + "TagDescriptionContracts" + ], + "description": "Create/Update tag description in scope of the Api.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagDescriptionId", + "in": "path", + "description": "Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TagDescriptionCreateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagDescriptionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TagDescriptionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApiTagDescription": { + "$ref": "./examples/ApiManagementCreateApiTagDescription.json" + } + } + }, + "delete": { + "operationId": "ApiTagDescription_Delete", + "tags": [ + "TagDescriptionContracts" + ], + "description": "Delete tag description for the Api.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagDescriptionId", + "in": "path", + "description": "Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteApiTagDescription": { + "$ref": "./examples/ApiManagementDeleteApiTagDescription.json" + } + } + }, + "head": { + "operationId": "ApiTagDescription_GetEntityTag", + "tags": [ + "TagDescriptionContracts" + ], + "description": "Gets the entity state version of the tag specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagDescriptionId", + "in": "path", + "description": "Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApiTagDescription": { + "$ref": "./examples/ApiManagementHeadApiTagDescription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags": { + "get": { + "operationId": "Tag_ListByApi", + "tags": [ + "Tag" + ], + "description": "Lists all Tags associated with the API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiTags": { + "$ref": "./examples/ApiManagementListApiTags.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}": { + "get": { + "operationId": "Tag_GetByApi", + "tags": [ + "Tag" + ], + "description": "Get tag associated with the API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiTag": { + "$ref": "./examples/ApiManagementGetApiTag.json" + } + } + }, + "put": { + "operationId": "Tag_AssignToApi", + "tags": [ + "Tag" + ], + "description": "Assign tag to the Api.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApiTag": { + "$ref": "./examples/ApiManagementCreateApiTag.json" + } + } + }, + "delete": { + "operationId": "Tag_DetachFromApi", + "tags": [ + "Tag" + ], + "description": "Detach the tag from the Api.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteApiTag": { + "$ref": "./examples/ApiManagementDeleteApiTag.json" + } + } + }, + "head": { + "operationId": "Tag_GetEntityStateByApi", + "tags": [ + "Tag" + ], + "description": "Gets the entity state version of the tag specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApiTag": { + "$ref": "./examples/ApiManagementHeadApiTag.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis": { + "get": { + "operationId": "ApiWikis_List", + "tags": [ + "WikiContracts" + ], + "description": "Gets the wikis for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WikiCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApiWikis": { + "$ref": "./examples/ApiManagementListApiWikis.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis/default": { + "get": { + "operationId": "ApiWiki_Get", + "tags": [ + "WikiContracts" + ], + "description": "Gets the details of the Wiki for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiWiki": { + "$ref": "./examples/ApiManagementGetApiWiki.json" + } + } + }, + "put": { + "operationId": "ApiWiki_CreateOrUpdate", + "tags": [ + "WikiContracts" + ], + "description": "Creates a new Wiki for an API or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WikiContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateApiWiki": { + "$ref": "./examples/ApiManagementCreateApiWiki.json" + } + } + }, + "patch": { + "operationId": "ApiWiki_Update", + "tags": [ + "WikiContracts" + ], + "description": "Updates the details of the Wiki for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Wiki Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WikiUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateApiWiki": { + "$ref": "./examples/ApiManagementUpdateApiWiki.json" + } + } + }, + "delete": { + "operationId": "ApiWiki_Delete", + "tags": [ + "WikiContracts" + ], + "description": "Deletes the specified Wiki from an API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementDeleteApiWiki": { + "$ref": "./examples/ApiManagementDeleteApiWiki.json" + } + } + }, + "head": { + "operationId": "ApiWiki_GetEntityTag", + "tags": [ + "WikiContracts" + ], + "description": "Gets the entity state (Etag) version of the Wiki for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApiWiki": { + "$ref": "./examples/ApiManagementHeadApiWiki.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags": { + "get": { + "operationId": "Api_ListByTags", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists a collection of apis associated with 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": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "includeNotTaggedApis", + "in": "query", + "description": "Include not tagged APIs.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagResourceCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApisByTags": { + "$ref": "./examples/ApiManagementListApisByTags.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates": { + "post": { + "operationId": "ApiManagementService_ApplyNetworkConfigurationUpdates", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region.", + "required": false, + "schema": { + "$ref": "#/definitions/ApiManagementServiceApplyNetworkConfigurationParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementApplyNetworkConfigurationUpdates": { + "$ref": "./examples/ApiManagementApplyNetworkConfigurationUpdates.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/ApiManagementServiceResource" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders": { + "get": { + "operationId": "AuthorizationProvider_ListByService", + "tags": [ + "AuthorizationProviderContracts" + ], + "description": "Lists a collection of authorization providers defined within a service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AuthorizationProviderCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListAuthorizationProviders": { + "$ref": "./examples/ApiManagementListAuthorizationProviders.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}": { + "get": { + "operationId": "AuthorizationProvider_Get", + "tags": [ + "AuthorizationProviderContracts" + ], + "description": "Gets the details of the authorization provider specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authorizationProviderId", + "in": "path", + "description": "Identifier of the authorization provider.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AuthorizationProviderContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetAuthorizationProvider": { + "$ref": "./examples/ApiManagementGetAuthorizationProvider.json" + } + } + }, + "put": { + "operationId": "AuthorizationProvider_CreateOrUpdate", + "tags": [ + "AuthorizationProviderContracts" + ], + "description": "Creates or updates authorization provider.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authorizationProviderId", + "in": "path", + "description": "Identifier of the authorization provider.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorizationProviderContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AuthorizationProviderContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/AuthorizationProviderContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateAuthorizationProviderAADAuthCode": { + "$ref": "./examples/ApiManagementCreateAuthorizationProviderAADAuthCode.json" + }, + "ApiManagementCreateAuthorizationProviderAADClientCred": { + "$ref": "./examples/ApiManagementCreateAuthorizationProviderAADClientCred.json" + }, + "ApiManagementCreateAuthorizationProviderGenericOAuth2": { + "$ref": "./examples/ApiManagementCreateAuthorizationProviderGenericOAuth2.json" + }, + "ApiManagementCreateAuthorizationProviderOOBGoogle": { + "$ref": "./examples/ApiManagementCreateAuthorizationProviderOOBGoogle.json" + } + } + }, + "delete": { + "operationId": "AuthorizationProvider_Delete", + "tags": [ + "AuthorizationProviderContracts" + ], + "description": "Deletes specific authorization provider from the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authorizationProviderId", + "in": "path", + "description": "Identifier of the authorization provider.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteAuthorizationProvider": { + "$ref": "./examples/ApiManagementDeleteAuthorizationProvider.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations": { + "get": { + "operationId": "Authorization_ListByAuthorizationProvider", + "tags": [ + "AuthorizationContracts" + ], + "description": "Lists a collection of authorization providers defined within a authorization provider.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authorizationProviderId", + "in": "path", + "description": "Identifier of the authorization provider.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AuthorizationCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListAuthorizationsAuthCode": { + "$ref": "./examples/ApiManagementListAuthorizationsAuthCode.json" + }, + "ApiManagementListAuthorizationsClientCred": { + "$ref": "./examples/ApiManagementListAuthorizationsClientCred.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}": { + "get": { + "operationId": "Authorization_Get", + "tags": [ + "AuthorizationContracts" + ], + "description": "Gets the details of the authorization specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authorizationProviderId", + "in": "path", + "description": "Identifier of the authorization provider.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "authorizationId", + "in": "path", + "description": "Identifier of the authorization.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AuthorizationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetAuthorization": { + "$ref": "./examples/ApiManagementGetAuthorization.json" + } + } + }, + "put": { + "operationId": "Authorization_CreateOrUpdate", + "tags": [ + "AuthorizationContracts" + ], + "description": "Creates or updates authorization.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authorizationProviderId", + "in": "path", + "description": "Identifier of the authorization provider.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "authorizationId", + "in": "path", + "description": "Identifier of the authorization.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorizationContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AuthorizationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/AuthorizationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateAuthorizationAADAuthCode": { + "$ref": "./examples/ApiManagementCreateAuthorizationAADAuthCode.json" + }, + "ApiManagementCreateAuthorizationAADClientCred": { + "$ref": "./examples/ApiManagementCreateAuthorizationAADClientCred.json" + } + } + }, + "delete": { + "operationId": "Authorization_Delete", + "tags": [ + "AuthorizationContracts" + ], + "description": "Deletes specific Authorization from the Authorization provider.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authorizationProviderId", + "in": "path", + "description": "Identifier of the authorization provider.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "authorizationId", + "in": "path", + "description": "Identifier of the authorization.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteAuthorization": { + "$ref": "./examples/ApiManagementDeleteAuthorization.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/accessPolicies": { + "get": { + "operationId": "AuthorizationAccessPolicy_ListByAuthorization", + "tags": [ + "AuthorizationAccessPolicyContracts" + ], + "description": "Lists a collection of authorization access policy defined within a authorization.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authorizationProviderId", + "in": "path", + "description": "Identifier of the authorization provider.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "authorizationId", + "in": "path", + "description": "Identifier of the authorization.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AuthorizationAccessPolicyCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListAuthorizationAccessPolicies": { + "$ref": "./examples/ApiManagementListAuthorizationAccessPolicies.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/accessPolicies/{authorizationAccessPolicyId}": { + "get": { + "operationId": "AuthorizationAccessPolicy_Get", + "tags": [ + "AuthorizationAccessPolicyContracts" + ], + "description": "Gets the details of the authorization access policy specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authorizationProviderId", + "in": "path", + "description": "Identifier of the authorization provider.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "authorizationId", + "in": "path", + "description": "Identifier of the authorization.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "authorizationAccessPolicyId", + "in": "path", + "description": "Identifier of the authorization access policy.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AuthorizationAccessPolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetAuthorizationAccessPolicy": { + "$ref": "./examples/ApiManagementGetAuthorizationAccessPolicy.json" + } + } + }, + "put": { + "operationId": "AuthorizationAccessPolicy_CreateOrUpdate", + "tags": [ + "AuthorizationAccessPolicyContracts" + ], + "description": "Creates or updates Authorization Access 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" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authorizationProviderId", + "in": "path", + "description": "Identifier of the authorization provider.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "authorizationId", + "in": "path", + "description": "Identifier of the authorization.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "authorizationAccessPolicyId", + "in": "path", + "description": "Identifier of the authorization access policy.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorizationAccessPolicyContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AuthorizationAccessPolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/AuthorizationAccessPolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateAuthorizationAccessPolicy": { + "$ref": "./examples/ApiManagementCreateAuthorizationAccessPolicy.json" + } + } + }, + "delete": { + "operationId": "AuthorizationAccessPolicy_Delete", + "tags": [ + "AuthorizationAccessPolicyContracts" + ], + "description": "Deletes specific access policy from the Authorization.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authorizationProviderId", + "in": "path", + "description": "Identifier of the authorization provider.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "authorizationId", + "in": "path", + "description": "Identifier of the authorization.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "authorizationAccessPolicyId", + "in": "path", + "description": "Identifier of the authorization access policy.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteAuthorizationAccessPolicy": { + "$ref": "./examples/ApiManagementDeleteAuthorizationAccessPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/confirmConsentCode": { + "post": { + "operationId": "Authorization_ConfirmConsentCode", + "tags": [ + "AuthorizationContracts" + ], + "description": "Confirm valid consent code to suppress Authorizations anti-phishing page.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authorizationProviderId", + "in": "path", + "description": "Identifier of the authorization provider.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "authorizationId", + "in": "path", + "description": "Identifier of the authorization.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorizationConfirmConsentCodeRequestContract" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementPostAuthorizationConfirmConsentCodeRequest": { + "$ref": "./examples/ApiManagementPostAuthorizationConfirmConsentCodeRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/getLoginLinks": { + "post": { + "operationId": "AuthorizationLoginLinks_Post", + "tags": [ + "AuthorizationContracts" + ], + "description": "Gets authorization login links.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authorizationProviderId", + "in": "path", + "description": "Identifier of the authorization provider.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "authorizationId", + "in": "path", + "description": "Identifier of the authorization.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorizationLoginRequestContract" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AuthorizationLoginResponseContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetAuthorizationLoginRequest": { + "$ref": "./examples/ApiManagementGetAuthorizationLoginRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers": { + "get": { + "operationId": "AuthorizationServer_ListByService", + "tags": [ + "AuthorizationServerContracts" + ], + "description": "Lists a collection of authorization servers defined within a service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AuthorizationServerCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListAuthorizationServers": { + "$ref": "./examples/ApiManagementListAuthorizationServers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}": { + "get": { + "operationId": "AuthorizationServer_Get", + "tags": [ + "AuthorizationServerContracts" + ], + "description": "Gets the details of the authorization server specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authsid", + "in": "path", + "description": "Identifier of the authorization server.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AuthorizationServerContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetAuthorizationServer": { + "$ref": "./examples/ApiManagementGetAuthorizationServer.json" + } + } + }, + "put": { + "operationId": "AuthorizationServer_CreateOrUpdate", + "tags": [ + "AuthorizationServerContracts" + ], + "description": "Creates new authorization server or updates an existing authorization 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" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authsid", + "in": "path", + "description": "Identifier of the authorization server.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorizationServerContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AuthorizationServerContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/AuthorizationServerContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateAuthorizationServer": { + "$ref": "./examples/ApiManagementCreateAuthorizationServer.json" + } + } + }, + "patch": { + "operationId": "AuthorizationServer_Update", + "tags": [ + "AuthorizationServerContracts" + ], + "description": "Updates the details of the authorization server specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authsid", + "in": "path", + "description": "Identifier of the authorization server.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "OAuth2 Server settings Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorizationServerUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AuthorizationServerContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateAuthorizationServer": { + "$ref": "./examples/ApiManagementUpdateAuthorizationServer.json" + } + } + }, + "delete": { + "operationId": "AuthorizationServer_Delete", + "tags": [ + "AuthorizationServerContracts" + ], + "description": "Deletes specific authorization server instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authsid", + "in": "path", + "description": "Identifier of the authorization server.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteAuthorizationServer": { + "$ref": "./examples/ApiManagementDeleteAuthorizationServer.json" + } + } + }, + "head": { + "operationId": "AuthorizationServer_GetEntityTag", + "tags": [ + "AuthorizationServerContracts" + ], + "description": "Gets the entity state (Etag) version of the authorizationServer specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authsid", + "in": "path", + "description": "Identifier of the authorization server.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadAuthorizationServer": { + "$ref": "./examples/ApiManagementHeadAuthorizationServer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}/listSecrets": { + "post": { + "operationId": "AuthorizationServer_ListSecrets", + "tags": [ + "AuthorizationServerContracts" + ], + "description": "Gets the client secret details of the authorization 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" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "authsid", + "in": "path", + "description": "Identifier of the authorization server.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AuthorizationServerSecretsContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementAuthorizationServerListSecrets": { + "$ref": "./examples/ApiManagementAuthorizationServerListSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends": { + "get": { + "operationId": "Backend_ListByService", + "tags": [ + "BackendContracts" + ], + "description": "Lists a collection of backends in the specified service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BackendCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListBackends": { + "$ref": "./examples/ApiManagementListBackends.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}": { + "get": { + "operationId": "Backend_Get", + "tags": [ + "BackendContracts" + ], + "description": "Gets the details of the backend specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "backendId", + "in": "path", + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BackendContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetBackend": { + "$ref": "./examples/ApiManagementGetBackend.json" + } + } + }, + "put": { + "operationId": "Backend_CreateOrUpdate", + "tags": [ + "BackendContracts" + ], + "description": "Creates or Updates a backend.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "backendId", + "in": "path", + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BackendContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BackendContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/BackendContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateBackendProxyBackend": { + "$ref": "./examples/ApiManagementCreateBackendProxyBackend.json" + }, + "ApiManagementCreateBackendServiceFabric": { + "$ref": "./examples/ApiManagementCreateBackendServiceFabric.json" + }, + "ApiManagementCreateBackendWithPriorityBasedLoadBalancer": { + "$ref": "./examples/ApiManagementCreateBackendWithPriorityBasedLoadBalancer.json" + }, + "ApiManagementCreateBackendWithSimpleLoadBalancer": { + "$ref": "./examples/ApiManagementCreateBackendWithSimpleLoadBalancer.json" + }, + "ApiManagementCreateBackendWithWeightedLoadBalancer": { + "$ref": "./examples/ApiManagementCreateBackendWithWeightedLoadBalancer.json" + } + } + }, + "patch": { + "operationId": "Backend_Update", + "tags": [ + "BackendContracts" + ], + "description": "Updates an existing backend.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "backendId", + "in": "path", + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BackendUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BackendContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateBackend": { + "$ref": "./examples/ApiManagementUpdateBackend.json" + } + } + }, + "delete": { + "operationId": "Backend_Delete", + "tags": [ + "BackendContracts" + ], + "description": "Deletes the specified backend.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "backendId", + "in": "path", + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteBackend": { + "$ref": "./examples/ApiManagementDeleteBackend.json" + } + } + }, + "head": { + "operationId": "Backend_GetEntityTag", + "tags": [ + "BackendContracts" + ], + "description": "Gets the entity state (Etag) version of the backend specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "backendId", + "in": "path", + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadBackend": { + "$ref": "./examples/ApiManagementHeadBackend.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}/reconnect": { + "post": { + "operationId": "Backend_Reconnect", + "tags": [ + "BackendContracts" + ], + "description": "Notifies the API Management gateway to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "backendId", + "in": "path", + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "parameters", + "in": "body", + "description": "Reconnect request parameters.", + "required": false, + "schema": { + "$ref": "#/definitions/BackendReconnectContract" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementBackendReconnect": { + "$ref": "./examples/ApiManagementBackendReconnect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup": { + "post": { + "operationId": "ApiManagementService_Backup", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the ApiManagementService_Backup operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceBackupRestoreParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementBackupWithAccessKey": { + "$ref": "./examples/ApiManagementBackupWithAccessKey.json" + }, + "ApiManagementBackupWithSystemManagedIdentity": { + "$ref": "./examples/ApiManagementBackupWithSystemManagedIdentity.json" + }, + "ApiManagementBackupWithUserAssignedManagedIdentity": { + "$ref": "./examples/ApiManagementBackupWithUserAssignedManagedIdentity.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/ApiManagementServiceResource" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches": { + "get": { + "operationId": "Cache_ListByService", + "tags": [ + "CacheContracts" + ], + "description": "Lists a collection of all external Caches in the specified service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CacheCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListCaches": { + "$ref": "./examples/ApiManagementListCaches.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches/{cacheId}": { + "get": { + "operationId": "Cache_Get", + "tags": [ + "CacheContracts" + ], + "description": "Gets the details of the Cache specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "cacheId", + "in": "path", + "description": "Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CacheContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetCache": { + "$ref": "./examples/ApiManagementGetCache.json" + } + } + }, + "put": { + "operationId": "Cache_CreateOrUpdate", + "tags": [ + "CacheContracts" + ], + "description": "Creates or updates an External Cache to be used in Api Management instance.", + "externalDocs": { + "description": "Use an external cache in Azure API Management", + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-cache-external" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "cacheId", + "in": "path", + "description": "Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CacheContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CacheContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/CacheContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateCache": { + "$ref": "./examples/ApiManagementCreateCache.json" + } + } + }, + "patch": { + "operationId": "Cache_Update", + "tags": [ + "CacheContracts" + ], + "description": "Updates the details of the cache specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "cacheId", + "in": "path", + "description": "Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CacheUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CacheContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateCache": { + "$ref": "./examples/ApiManagementUpdateCache.json" + } + } + }, + "delete": { + "operationId": "Cache_Delete", + "tags": [ + "CacheContracts" + ], + "description": "Deletes specific Cache.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "cacheId", + "in": "path", + "description": "Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteCache": { + "$ref": "./examples/ApiManagementDeleteCache.json" + } + } + }, + "head": { + "operationId": "Cache_GetEntityTag", + "tags": [ + "CacheContracts" + ], + "description": "Gets the entity state (Etag) version of the Cache specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "cacheId", + "in": "path", + "description": "Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadCache": { + "$ref": "./examples/ApiManagementHeadCache.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates": { + "get": { + "operationId": "Certificate_ListByService", + "tags": [ + "CertificateContracts" + ], + "description": "Lists a collection of all certificates in the specified service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| expirationDate | filter | ge, le, eq, ne, gt, lt | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "isKeyVaultRefreshFailed", + "in": "query", + "description": "When set to true, the response contains only certificates entities which failed refresh.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListCertificates": { + "$ref": "./examples/ApiManagementListCertificates.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}": { + "get": { + "operationId": "Certificate_Get", + "tags": [ + "CertificateContracts" + ], + "description": "Gets the details of the certificate specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "certificateId", + "in": "path", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CertificateContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetCertificate": { + "$ref": "./examples/ApiManagementGetCertificate.json" + }, + "ApiManagementGetCertificateWithKeyVault": { + "$ref": "./examples/ApiManagementGetCertificateWithKeyVault.json" + } + } + }, + "put": { + "operationId": "Certificate_CreateOrUpdate", + "tags": [ + "CertificateContracts" + ], + "description": "Creates or updates the certificate being used for authentication with the backend.", + "externalDocs": { + "description": "How to secure back-end services using client certificate authentication in Azure API Management", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "certificateId", + "in": "path", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateCreateOrUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CertificateContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/CertificateContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateCertificate": { + "$ref": "./examples/ApiManagementCreateCertificate.json" + }, + "ApiManagementCreateCertificateWithKeyVault": { + "$ref": "./examples/ApiManagementCreateCertificateWithKeyVault.json" + } + } + }, + "delete": { + "operationId": "Certificate_Delete", + "tags": [ + "CertificateContracts" + ], + "description": "Deletes specific certificate.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "certificateId", + "in": "path", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteCertificate": { + "$ref": "./examples/ApiManagementDeleteCertificate.json" + } + } + }, + "head": { + "operationId": "Certificate_GetEntityTag", + "tags": [ + "CertificateContracts" + ], + "description": "Gets the entity state (Etag) version of the certificate specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "certificateId", + "in": "path", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadCertificate": { + "$ref": "./examples/ApiManagementHeadCertificate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}/refreshSecret": { + "post": { + "operationId": "Certificate_RefreshSecret", + "tags": [ + "CertificateContracts" + ], + "description": "From KeyVault, Refresh the certificate being used for authentication with the backend.", + "externalDocs": { + "description": "How to secure back-end services using client certificate authentication in Azure API Management", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "certificateId", + "in": "path", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementRefreshCertificate": { + "$ref": "./examples/ApiManagementRefreshCertificate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/clientApplications": { + "get": { + "operationId": "ClientApplication_ListByService", + "tags": [ + "ClientApplicationContracts" + ], + "description": "Lists a collection of client applications in the specified service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
state | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClientApplicationCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListProducts": { + "$ref": "./examples/ApiManagementListClientApplications.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/clientApplications/{clientApplicationId}": { + "get": { + "operationId": "ClientApplication_Get", + "tags": [ + "ClientApplicationContracts" + ], + "description": "Gets the details of the client application specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "clientApplicationId", + "in": "path", + "description": "Client Application identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ClientApplicationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetClientApplication": { + "$ref": "./examples/ApiManagementGetClientApplication.json" + } + } + }, + "put": { + "operationId": "ClientApplication_CreateOrUpdate", + "tags": [ + "ClientApplicationContracts" + ], + "description": "Creates or Updates a client application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "clientApplicationId", + "in": "path", + "description": "Client Application identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ClientApplicationContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ClientApplicationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/ClientApplicationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateProduct": { + "$ref": "./examples/ApiManagementCreateClientApplication.json" + } + } + }, + "delete": { + "operationId": "ClientApplication_Delete", + "tags": [ + "ClientApplicationContracts" + ], + "description": "Delete client application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "clientApplicationId", + "in": "path", + "description": "Client Application identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteProduct": { + "$ref": "./examples/ApiManagementDeleteClientApplication.json" + } + } + }, + "head": { + "operationId": "ClientApplication_GetEntityTag", + "tags": [ + "ClientApplicationContracts" + ], + "description": "Gets the entity state (Etag) version of the product specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "clientApplicationId", + "in": "path", + "description": "Client Application identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadProduct": { + "$ref": "./examples/ApiManagementHeadClientApplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/clientApplications/{clientApplicationId}/listSecrets": { + "post": { + "operationId": "ClientApplication_ListSecrets", + "tags": [ + "ClientApplicationContracts" + ], + "description": "Retrived client application secrets.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "clientApplicationId", + "in": "path", + "description": "Client Application identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClientApplicationSecretsContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListProducts": { + "$ref": "./examples/ApiManagementListClientApplicationSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/clientApplications/{clientApplicationId}/productLinks": { + "get": { + "operationId": "ClientApplicationProductLink_ListByClientApplications", + "tags": [ + "ClientApplicationProductLinkContracts" + ], + "description": "Lists a collection of product links associated with the specified client application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "clientApplicationId", + "in": "path", + "description": "Client Application identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClientApplicationProductLinkCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListProducts": { + "$ref": "./examples/ApiManagementListClientApplicationProductLinks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/clientApplications/{clientApplicationId}/productLinks/{clientApplicationProductLinkId}": { + "get": { + "operationId": "ClientApplicationProductLink_Get", + "tags": [ + "ClientApplicationProductLinkContracts" + ], + "description": "Gets the product link for the client application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "clientApplicationId", + "in": "path", + "description": "Client Application identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "clientApplicationProductLinkId", + "in": "path", + "description": "Client Application Product Link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ClientApplicationProductLinkContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetProductApiLink": { + "$ref": "./examples/ApiManagementGetClientApplicationProductLink.json" + } + } + }, + "put": { + "operationId": "ClientApplicationProductLink_Create", + "tags": [ + "ClientApplicationProductLinkContracts" + ], + "description": "Adds an Product to the specified Client Application via link.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "clientApplicationId", + "in": "path", + "description": "Client Application identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "clientApplicationProductLinkId", + "in": "path", + "description": "Client Application Product Link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ClientApplicationProductLinkContract" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ClientApplicationProductLinkContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/ClientApplicationProductLinkContract" + } + }, + "201": { + "description": "Resource 'ClientApplicationProductLinkContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/ClientApplicationProductLinkContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateClientApplicationProductLink": { + "$ref": "./examples/ApiManagementCreateClientApplicationProductLink.json" + } + } + }, + "delete": { + "operationId": "ClientApplicationProductLink_Delete", + "tags": [ + "ClientApplicationProductLinkContracts" + ], + "description": "Deletes the specified Product from the specified client application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "clientApplicationId", + "in": "path", + "description": "Client Application identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "clientApplicationProductLinkId", + "in": "path", + "description": "Client Application Product Link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteClientApplicationProductLink": { + "$ref": "./examples/ApiManagementDeleteClientApplicationProductLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/connectivityCheck": { + "post": { + "operationId": "PerformConnectivityCheckAsync", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "connectivityCheckRequestParams", + "in": "body", + "description": "Connectivity Check request parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectivityCheckRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ConnectivityCheckResponse" + } + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HTTP Connectivity Check": { + "$ref": "./examples/ApiManagementPerformConnectivityCheckHttpConnect.json" + }, + "TCP Connectivity Check": { + "$ref": "./examples/ApiManagementPerformConnectivityCheck.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/ConnectivityCheckResponse" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes": { + "get": { + "operationId": "ContentType_ListByService", + "tags": [ + "ContentTypeContracts" + ], + "description": "Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ContentTypeCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListContentTypes": { + "$ref": "./examples/ApiManagementListContentTypes.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}": { + "get": { + "operationId": "ContentType_Get", + "tags": [ + "ContentTypeContracts" + ], + "description": "Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "contentTypeId", + "in": "path", + "description": "Content type identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ContentTypeContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetContentType": { + "$ref": "./examples/ApiManagementGetContentType.json" + } + } + }, + "put": { + "operationId": "ContentType_CreateOrUpdate", + "tags": [ + "ContentTypeContracts" + ], + "description": "Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the `c-` prefix. Built-in content types can't be modified.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "contentTypeId", + "in": "path", + "description": "Content type identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ContentTypeContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ContentTypeContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/ContentTypeContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateContentType": { + "$ref": "./examples/ApiManagementCreateContentType.json" + } + } + }, + "delete": { + "operationId": "ContentType_Delete", + "tags": [ + "ContentTypeContracts" + ], + "description": "Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the `c-` prefix) can't be removed.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "contentTypeId", + "in": "path", + "description": "Content type identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteContentType": { + "$ref": "./examples/ApiManagementDeleteContentType.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems": { + "get": { + "operationId": "ContentItem_ListByService", + "tags": [ + "ContentItemContracts" + ], + "description": "Lists developer portal's content items specified by the provided content type.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "contentTypeId", + "in": "path", + "description": "Content type identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ContentItemCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListContentTypeContentItems": { + "$ref": "./examples/ApiManagementListContentTypeContentItems.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}": { + "get": { + "operationId": "ContentItem_Get", + "tags": [ + "ContentItemContracts" + ], + "description": "Returns the developer portal's content item specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "contentTypeId", + "in": "path", + "description": "Content type identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "contentItemId", + "in": "path", + "description": "Content item identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ContentItemContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetContentTypeContentItem": { + "$ref": "./examples/ApiManagementGetContentTypeContentItem.json" + } + } + }, + "put": { + "operationId": "ContentItem_CreateOrUpdate", + "tags": [ + "ContentItemContracts" + ], + "description": "Creates a new developer portal's content item specified by the provided content type.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "contentTypeId", + "in": "path", + "description": "Content type identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "contentItemId", + "in": "path", + "description": "Content item identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ContentItemContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ContentItemContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/ContentItemContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateContentTypeContentItem": { + "$ref": "./examples/ApiManagementCreateContentTypeContentItem.json" + } + } + }, + "delete": { + "operationId": "ContentItem_Delete", + "tags": [ + "ContentItemContracts" + ], + "description": "Removes the specified developer portal's content item.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "contentTypeId", + "in": "path", + "description": "Content type identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "contentItemId", + "in": "path", + "description": "Content item identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteContentTypeContentItem": { + "$ref": "./examples/ApiManagementDeleteContentTypeContentItem.json" + } + } + }, + "head": { + "operationId": "ContentItem_GetEntityTag", + "tags": [ + "ContentItemContracts" + ], + "description": "Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "contentTypeId", + "in": "path", + "description": "Content type identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "contentItemId", + "in": "path", + "description": "Content item identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadContentTypeContentItem": { + "$ref": "./examples/ApiManagementHeadContentTypeContentItem.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics": { + "get": { + "operationId": "Diagnostic_ListByService", + "tags": [ + "Diagnostic" + ], + "description": "Lists all diagnostics of the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiagnosticCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListDiagnostics": { + "$ref": "./examples/ApiManagementListDiagnostics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}": { + "get": { + "operationId": "Diagnostic_Get", + "tags": [ + "Diagnostic" + ], + "description": "Gets the details of the Diagnostic specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetDiagnostic": { + "$ref": "./examples/ApiManagementGetDiagnostic.json" + } + } + }, + "put": { + "operationId": "Diagnostic_CreateOrUpdate", + "tags": [ + "Diagnostic" + ], + "description": "Creates a new Diagnostic or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateDiagnostic": { + "$ref": "./examples/ApiManagementCreateDiagnostic.json" + } + } + }, + "patch": { + "operationId": "Diagnostic_Update", + "tags": [ + "Diagnostic" + ], + "description": "Updates the details of the Diagnostic specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Diagnostic Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateDiagnostic": { + "$ref": "./examples/ApiManagementUpdateDiagnostic.json" + } + } + }, + "delete": { + "operationId": "Diagnostic_Delete", + "tags": [ + "Diagnostic" + ], + "description": "Deletes the specified Diagnostic.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteDiagnostic": { + "$ref": "./examples/ApiManagementDeleteDiagnostic.json" + } + } + }, + "head": { + "operationId": "Diagnostic_GetEntityTag", + "tags": [ + "Diagnostic" + ], + "description": "Gets the entity state (Etag) version of the Diagnostic specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadDiagnostic": { + "$ref": "./examples/ApiManagementHeadDiagnostic.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations": { + "get": { + "operationId": "Documentation_ListByService", + "tags": [ + "DocumentationContracts" + ], + "description": "Lists all Documentations of the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DocumentationCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListApis": { + "$ref": "./examples/ApiManagementListDocumentations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}": { + "get": { + "operationId": "Documentation_Get", + "tags": [ + "DocumentationContracts" + ], + "description": "Gets the details of the Documentation specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "documentationId", + "in": "path", + "description": "Documentation identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DocumentationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetDocumentation": { + "$ref": "./examples/ApiManagementGetDocumentation.json" + } + } + }, + "put": { + "operationId": "Documentation_CreateOrUpdate", + "tags": [ + "DocumentationContracts" + ], + "description": "Creates a new Documentation or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "documentationId", + "in": "path", + "description": "Documentation identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DocumentationContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DocumentationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/DocumentationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateDocumentation": { + "$ref": "./examples/ApiManagementCreateDocumentation.json" + } + } + }, + "patch": { + "operationId": "Documentation_Update", + "tags": [ + "DocumentationContracts" + ], + "description": "Updates the details of the Documentation for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "documentationId", + "in": "path", + "description": "Documentation identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Documentation Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DocumentationUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DocumentationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateDocumentation": { + "$ref": "./examples/ApiManagementUpdateDocumentation.json" + } + } + }, + "delete": { + "operationId": "Documentation_Delete", + "tags": [ + "DocumentationContracts" + ], + "description": "Deletes the specified Documentation from an API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "documentationId", + "in": "path", + "description": "Documentation identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteDocumentation": { + "$ref": "./examples/ApiManagementDeleteDocumentation.json" + } + } + }, + "head": { + "operationId": "Documentation_GetEntityTag", + "tags": [ + "DocumentationContracts" + ], + "description": "Gets the entity state (Etag) version of the Documentation by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "documentationId", + "in": "path", + "description": "Documentation identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadDocumentation": { + "$ref": "./examples/ApiManagementHeadDocumentation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways": { + "get": { + "operationId": "Gateway_ListByService", + "tags": [ + "GatewayContracts" + ], + "description": "Lists a collection of gateways registered with service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| region | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GatewayCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListGateways": { + "$ref": "./examples/ApiManagementListGateways.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}": { + "get": { + "operationId": "Gateway_Get", + "tags": [ + "GatewayContracts" + ], + "description": "Gets the details of the Gateway specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GatewayContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetGateway": { + "$ref": "./examples/ApiManagementGetGateway.json" + } + } + }, + "put": { + "operationId": "Gateway_CreateOrUpdate", + "tags": [ + "GatewayContracts" + ], + "description": "Creates or updates a Gateway to be used in Api Management instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GatewayContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/GatewayContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateGateway": { + "$ref": "./examples/ApiManagementCreateGateway.json" + } + } + }, + "patch": { + "operationId": "Gateway_Update", + "tags": [ + "GatewayContracts" + ], + "description": "Updates the details of the gateway specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GatewayContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateGateway": { + "$ref": "./examples/ApiManagementUpdateGateway.json" + } + } + }, + "delete": { + "operationId": "Gateway_Delete", + "tags": [ + "GatewayContracts" + ], + "description": "Deletes specific Gateway.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteGateway": { + "$ref": "./examples/ApiManagementDeleteGateway.json" + } + } + }, + "head": { + "operationId": "Gateway_GetEntityTag", + "tags": [ + "GatewayContracts" + ], + "description": "Gets the entity state (Etag) version of the Gateway specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadGateway": { + "$ref": "./examples/ApiManagementHeadGateway.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis": { + "get": { + "operationId": "GatewayApi_ListByService", + "tags": [ + "GatewayContracts" + ], + "description": "Lists a collection of the APIs associated with a gateway.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListGatewayApis": { + "$ref": "./examples/ApiManagementListGatewayApis.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}": { + "put": { + "operationId": "GatewayApi_CreateOrUpdate", + "tags": [ + "GatewayContracts" + ], + "description": "Adds an API to the specified Gateway.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "parameters", + "in": "body", + "description": "", + "required": false, + "schema": { + "$ref": "#/definitions/AssociationContract" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiContract" + } + }, + "201": { + "description": "Resource 'ApiContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApiContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateGatewayApi": { + "$ref": "./examples/ApiManagementCreateGatewayApi.json" + } + } + }, + "delete": { + "operationId": "GatewayApi_Delete", + "tags": [ + "GatewayContracts" + ], + "description": "Deletes the specified API from the specified Gateway.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementDeleteGatewayApi": { + "$ref": "./examples/ApiManagementDeleteGatewayApi.json" + } + } + }, + "head": { + "operationId": "GatewayApi_GetEntityTag", + "tags": [ + "GatewayContracts" + ], + "description": "Checks that API entity specified by identifier is associated with the Gateway entity.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadGatewayApi": { + "$ref": "./examples/ApiManagementHeadGatewayApi.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities": { + "get": { + "operationId": "GatewayCertificateAuthority_ListByService", + "tags": [ + "GatewayCertificateAuthorityContracts" + ], + "description": "Lists the collection of Certificate Authorities for the specified Gateway entity.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq, ne | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GatewayCertificateAuthorityCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListGatewaycertificateAuthorities": { + "$ref": "./examples/ApiManagementListGatewayCertificateAuthorities.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}": { + "get": { + "operationId": "GatewayCertificateAuthority_Get", + "tags": [ + "GatewayCertificateAuthorityContracts" + ], + "description": "Get assigned Gateway Certificate Authority details.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "certificateId", + "in": "path", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GatewayCertificateAuthorityContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetGatewayCertificateAuthority": { + "$ref": "./examples/ApiManagementGetGatewayCertificateAuthority.json" + } + } + }, + "put": { + "operationId": "GatewayCertificateAuthority_CreateOrUpdate", + "tags": [ + "GatewayCertificateAuthorityContracts" + ], + "description": "Assign Certificate entity to Gateway entity as Certificate Authority.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "certificateId", + "in": "path", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayCertificateAuthorityContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GatewayCertificateAuthorityContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/GatewayCertificateAuthorityContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateGatewayCertificateAuthority": { + "$ref": "./examples/ApiManagementCreateGatewayCertificateAuthority.json" + } + } + }, + "delete": { + "operationId": "GatewayCertificateAuthority_Delete", + "tags": [ + "GatewayCertificateAuthorityContracts" + ], + "description": "Remove relationship between Certificate Authority and Gateway entity.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "certificateId", + "in": "path", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteGatewayCertificateAuthority": { + "$ref": "./examples/ApiManagementDeleteGatewayCertificateAuthority.json" + } + } + }, + "head": { + "operationId": "GatewayCertificateAuthority_GetEntityTag", + "tags": [ + "GatewayCertificateAuthorityContracts" + ], + "description": "Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "certificateId", + "in": "path", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadGatewayCertificateAuthority": { + "$ref": "./examples/ApiManagementHeadGatewayCertificateAuthority.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken": { + "post": { + "operationId": "Gateway_GenerateToken", + "tags": [ + "GatewayContracts" + ], + "description": "Gets the Shared Access Authorization Token for the gateway.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "parameters", + "in": "body", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayTokenRequestContract" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GatewayTokenContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGatewayGenerateToken": { + "$ref": "./examples/ApiManagementGatewayGenerateToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations": { + "get": { + "operationId": "GatewayHostnameConfiguration_ListByService", + "tags": [ + "GatewayHostnameConfigurationContracts" + ], + "description": "Lists the collection of hostname configurations for the specified gateway.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| hostname | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GatewayHostnameConfigurationCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListGatewayHostnameConfigurations": { + "$ref": "./examples/ApiManagementListGatewayHostnameConfigurations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}": { + "get": { + "operationId": "GatewayHostnameConfiguration_Get", + "tags": [ + "GatewayHostnameConfigurationContracts" + ], + "description": "Get details of a hostname configuration", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "hcId", + "in": "path", + "description": "Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GatewayHostnameConfigurationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetGatewayHostnameConfiguration": { + "$ref": "./examples/ApiManagementGetGatewayHostnameConfiguration.json" + } + } + }, + "put": { + "operationId": "GatewayHostnameConfiguration_CreateOrUpdate", + "tags": [ + "GatewayHostnameConfigurationContracts" + ], + "description": "Creates of updates hostname configuration for a Gateway.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "hcId", + "in": "path", + "description": "Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayHostnameConfigurationContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GatewayHostnameConfigurationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/GatewayHostnameConfigurationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateGatewayHostnameConfiguration": { + "$ref": "./examples/ApiManagementCreateGatewayHostnameConfiguration.json" + } + } + }, + "delete": { + "operationId": "GatewayHostnameConfiguration_Delete", + "tags": [ + "GatewayHostnameConfigurationContracts" + ], + "description": "Deletes the specified hostname configuration from the specified Gateway.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "hcId", + "in": "path", + "description": "Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteGatewayHostnameConfiguration": { + "$ref": "./examples/ApiManagementDeleteGatewayHostnameConfiguration.json" + } + } + }, + "head": { + "operationId": "GatewayHostnameConfiguration_GetEntityTag", + "tags": [ + "GatewayHostnameConfigurationContracts" + ], + "description": "Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "hcId", + "in": "path", + "description": "Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadGatewayHostnameConfiguration": { + "$ref": "./examples/ApiManagementHeadGatewayHostnameConfiguration.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/invalidateDebugCredentials": { + "post": { + "operationId": "Gateway_InvalidateDebugCredentials", + "tags": [ + "GatewayContracts" + ], + "description": "Action is invalidating all debug credentials issued for gateway.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGatewayInvalidateDebugCredentials": { + "$ref": "./examples/ApiManagementGatewayInvalidateDebugCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listDebugCredentials": { + "post": { + "operationId": "Gateway_ListDebugCredentials", + "tags": [ + "GatewayContracts" + ], + "description": "Create new debug credentials for gateway.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "parameters", + "in": "body", + "description": "List debug credentials properties.", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayListDebugCredentialsContract" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GatewayDebugCredentialsContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGatewayListDebugCredentials": { + "$ref": "./examples/ApiManagementGatewayListDebugCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys": { + "post": { + "operationId": "Gateway_ListKeys", + "tags": [ + "GatewayContracts" + ], + "description": "Retrieves gateway keys.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GatewayKeysContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGatewayListKeys": { + "$ref": "./examples/ApiManagementGatewayListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listTrace": { + "post": { + "operationId": "Gateway_ListTrace", + "tags": [ + "GatewayContracts" + ], + "description": "Fetches trace collected by gateway.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "parameters", + "in": "body", + "description": "List trace properties.", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayListTraceContract" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GatewayTraceContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGatewayListTrace": { + "$ref": "./examples/ApiManagementGatewayListTrace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/regenerateKey": { + "post": { + "operationId": "Gateway_RegenerateKey", + "tags": [ + "GatewayContracts" + ], + "description": "Regenerates specified gateway key invalidating any tokens created with it.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "gatewayId", + "in": "path", + "description": "Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "parameters", + "in": "body", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/GatewayKeyRegenerationRequestContract" + } + } + ], + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGatewayRegenerateKey": { + "$ref": "./examples/ApiManagementGatewayRegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/getssotoken": { + "post": { + "operationId": "ApiManagementService_GetSsoToken", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceGetSsoTokenResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementServiceGetSsoToken": { + "$ref": "./examples/ApiManagementServiceGetSsoToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups": { + "get": { + "operationId": "Group_ListByService", + "tags": [ + "GroupContracts" + ], + "description": "Lists a collection of groups defined within a service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-groups" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| externalId | filter | eq | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GroupCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListGroups": { + "$ref": "./examples/ApiManagementListGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}": { + "get": { + "operationId": "Group_Get", + "tags": [ + "GroupContracts" + ], + "description": "Gets the details of the group specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetGroup": { + "$ref": "./examples/ApiManagementGetGroup.json" + } + } + }, + "put": { + "operationId": "Group_CreateOrUpdate", + "tags": [ + "GroupContracts" + ], + "description": "Creates or Updates 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": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GroupCreateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateGroup": { + "$ref": "./examples/ApiManagementCreateGroup.json" + }, + "ApiManagementCreateGroupExternal": { + "$ref": "./examples/ApiManagementCreateGroupExternal.json" + } + } + }, + "patch": { + "operationId": "Group_Update", + "tags": [ + "GroupContracts" + ], + "description": "Updates the details of the group specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GroupUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateGroup": { + "$ref": "./examples/ApiManagementUpdateGroup.json" + } + } + }, + "delete": { + "operationId": "Group_Delete", + "tags": [ + "GroupContracts" + ], + "description": "Deletes specific group of the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteGroup": { + "$ref": "./examples/ApiManagementDeleteGroup.json" + } + } + }, + "head": { + "operationId": "Group_GetEntityTag", + "tags": [ + "GroupContracts" + ], + "description": "Gets the entity state (Etag) version of the group specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadGroup": { + "$ref": "./examples/ApiManagementHeadGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users": { + "get": { + "operationId": "GroupUser_List", + "tags": [ + "GroupContracts" + ], + "description": "Lists a collection of user entities associated with the 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": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UserCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListGroupUsers": { + "$ref": "./examples/ApiManagementListGroupUsers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}": { + "put": { + "operationId": "GroupUser_Create", + "tags": [ + "GroupContracts" + ], + "description": "Add existing user to existing 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": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UserContract" + } + }, + "201": { + "description": "Resource 'UserContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/UserContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateGroupUser": { + "$ref": "./examples/ApiManagementCreateGroupUser.json" + } + } + }, + "delete": { + "operationId": "GroupUser_Delete", + "tags": [ + "GroupContracts" + ], + "description": "Remove existing user from existing 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": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementDeleteGroupUser": { + "$ref": "./examples/ApiManagementDeleteGroupUser.json" + } + } + }, + "head": { + "operationId": "GroupUser_CheckEntityExists", + "tags": [ + "GroupContracts" + ], + "description": "Checks that user entity specified by identifier is associated with the group entity.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "404": { + "description": "The server cannot find the requested resource." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadGroupUser": { + "$ref": "./examples/ApiManagementHeadGroupUser.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders": { + "get": { + "operationId": "IdentityProvider_ListByService", + "tags": [ + "IdentityProviderContracts" + ], + "description": "Lists a collection of Identity Provider configured in the specified service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-aad#how-to-authorize-developer-accounts-using-azure-active-directory" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IdentityProviderList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListIdentityProviders": { + "$ref": "./examples/ApiManagementListIdentityProviders.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}": { + "get": { + "operationId": "IdentityProvider_Get", + "tags": [ + "IdentityProviderContracts" + ], + "description": "Gets the configuration details of the identity Provider configured in specified service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "identityProviderName", + "in": "path", + "description": "Identity Provider Type identifier.", + "required": true, + "type": "string", + "enum": [ + "facebook", + "google", + "microsoft", + "twitter", + "aad", + "aadB2C" + ], + "x-ms-enum": { + "name": "IdentityProviderType", + "modelAsString": true, + "values": [ + { + "name": "facebook", + "value": "facebook", + "description": "Facebook as Identity provider." + }, + { + "name": "google", + "value": "google", + "description": "Google as Identity provider." + }, + { + "name": "microsoft", + "value": "microsoft", + "description": "Microsoft Live as Identity provider." + }, + { + "name": "twitter", + "value": "twitter", + "description": "Twitter as Identity provider." + }, + { + "name": "aad", + "value": "aad", + "description": "Azure Active Directory as Identity provider." + }, + { + "name": "aadB2C", + "value": "aadB2C", + "description": "Azure Active Directory B2C as Identity provider." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/IdentityProviderContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetIdentityProvider": { + "$ref": "./examples/ApiManagementGetIdentityProvider.json" + } + } + }, + "put": { + "operationId": "IdentityProvider_CreateOrUpdate", + "tags": [ + "IdentityProviderContracts" + ], + "description": "Creates or Updates the IdentityProvider configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "identityProviderName", + "in": "path", + "description": "Identity Provider Type identifier.", + "required": true, + "type": "string", + "enum": [ + "facebook", + "google", + "microsoft", + "twitter", + "aad", + "aadB2C" + ], + "x-ms-enum": { + "name": "IdentityProviderType", + "modelAsString": true, + "values": [ + { + "name": "facebook", + "value": "facebook", + "description": "Facebook as Identity provider." + }, + { + "name": "google", + "value": "google", + "description": "Google as Identity provider." + }, + { + "name": "microsoft", + "value": "microsoft", + "description": "Microsoft Live as Identity provider." + }, + { + "name": "twitter", + "value": "twitter", + "description": "Twitter as Identity provider." + }, + { + "name": "aad", + "value": "aad", + "description": "Azure Active Directory as Identity provider." + }, + { + "name": "aadB2C", + "value": "aadB2C", + "description": "Azure Active Directory B2C as Identity provider." + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IdentityProviderCreateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/IdentityProviderContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/IdentityProviderContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateIdentityProvider": { + "$ref": "./examples/ApiManagementCreateIdentityProvider.json" + } + } + }, + "patch": { + "operationId": "IdentityProvider_Update", + "tags": [ + "IdentityProviderContracts" + ], + "description": "Updates an existing IdentityProvider configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "identityProviderName", + "in": "path", + "description": "Identity Provider Type identifier.", + "required": true, + "type": "string", + "enum": [ + "facebook", + "google", + "microsoft", + "twitter", + "aad", + "aadB2C" + ], + "x-ms-enum": { + "name": "IdentityProviderType", + "modelAsString": true, + "values": [ + { + "name": "facebook", + "value": "facebook", + "description": "Facebook as Identity provider." + }, + { + "name": "google", + "value": "google", + "description": "Google as Identity provider." + }, + { + "name": "microsoft", + "value": "microsoft", + "description": "Microsoft Live as Identity provider." + }, + { + "name": "twitter", + "value": "twitter", + "description": "Twitter as Identity provider." + }, + { + "name": "aad", + "value": "aad", + "description": "Azure Active Directory as Identity provider." + }, + { + "name": "aadB2C", + "value": "aadB2C", + "description": "Azure Active Directory B2C as Identity provider." + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IdentityProviderUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/IdentityProviderContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateIdentityProvider": { + "$ref": "./examples/ApiManagementUpdateIdentityProvider.json" + } + } + }, + "delete": { + "operationId": "IdentityProvider_Delete", + "tags": [ + "IdentityProviderContracts" + ], + "description": "Deletes the specified identity provider configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "identityProviderName", + "in": "path", + "description": "Identity Provider Type identifier.", + "required": true, + "type": "string", + "enum": [ + "facebook", + "google", + "microsoft", + "twitter", + "aad", + "aadB2C" + ], + "x-ms-enum": { + "name": "IdentityProviderType", + "modelAsString": true, + "values": [ + { + "name": "facebook", + "value": "facebook", + "description": "Facebook as Identity provider." + }, + { + "name": "google", + "value": "google", + "description": "Google as Identity provider." + }, + { + "name": "microsoft", + "value": "microsoft", + "description": "Microsoft Live as Identity provider." + }, + { + "name": "twitter", + "value": "twitter", + "description": "Twitter as Identity provider." + }, + { + "name": "aad", + "value": "aad", + "description": "Azure Active Directory as Identity provider." + }, + { + "name": "aadB2C", + "value": "aadB2C", + "description": "Azure Active Directory B2C as Identity provider." + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteIdentityProvider": { + "$ref": "./examples/ApiManagementDeleteIdentityProvider.json" + } + } + }, + "head": { + "operationId": "IdentityProvider_GetEntityTag", + "tags": [ + "IdentityProviderContracts" + ], + "description": "Gets the entity state (Etag) version of the identityProvider specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "identityProviderName", + "in": "path", + "description": "Identity Provider Type identifier.", + "required": true, + "type": "string", + "enum": [ + "facebook", + "google", + "microsoft", + "twitter", + "aad", + "aadB2C" + ], + "x-ms-enum": { + "name": "IdentityProviderType", + "modelAsString": true, + "values": [ + { + "name": "facebook", + "value": "facebook", + "description": "Facebook as Identity provider." + }, + { + "name": "google", + "value": "google", + "description": "Google as Identity provider." + }, + { + "name": "microsoft", + "value": "microsoft", + "description": "Microsoft Live as Identity provider." + }, + { + "name": "twitter", + "value": "twitter", + "description": "Twitter as Identity provider." + }, + { + "name": "aad", + "value": "aad", + "description": "Azure Active Directory as Identity provider." + }, + { + "name": "aadB2C", + "value": "aadB2C", + "description": "Azure Active Directory B2C as Identity provider." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadIdentityProvider": { + "$ref": "./examples/ApiManagementHeadIdentityProvider.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}/listSecrets": { + "post": { + "operationId": "IdentityProvider_ListSecrets", + "tags": [ + "IdentityProviderContracts" + ], + "description": "Gets the client secret details of the Identity Provider.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "identityProviderName", + "in": "path", + "description": "Identity Provider Type identifier.", + "required": true, + "type": "string", + "enum": [ + "facebook", + "google", + "microsoft", + "twitter", + "aad", + "aadB2C" + ], + "x-ms-enum": { + "name": "IdentityProviderType", + "modelAsString": true, + "values": [ + { + "name": "facebook", + "value": "facebook", + "description": "Facebook as Identity provider." + }, + { + "name": "google", + "value": "google", + "description": "Google as Identity provider." + }, + { + "name": "microsoft", + "value": "microsoft", + "description": "Microsoft Live as Identity provider." + }, + { + "name": "twitter", + "value": "twitter", + "description": "Twitter as Identity provider." + }, + { + "name": "aad", + "value": "aad", + "description": "Azure Active Directory as Identity provider." + }, + { + "name": "aadB2C", + "value": "aadB2C", + "description": "Azure Active Directory B2C as Identity provider." + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClientSecretContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementIdentityProviderListSecrets": { + "$ref": "./examples/ApiManagementIdentityProviderListSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues": { + "get": { + "operationId": "Issue_ListByService", + "tags": [ + "Issue" + ], + "description": "Lists a collection of issues in the specified service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| authorName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IssueCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListIssues": { + "$ref": "./examples/ApiManagementListIssues.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues/{issueId}": { + "get": { + "operationId": "Issue_Get", + "tags": [ + "Issue" + ], + "description": "Gets API Management issue details", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "issueId", + "in": "path", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetIssue": { + "$ref": "./examples/ApiManagementGetIssue.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/locations/{locationName}/networkstatus": { + "get": { + "operationId": "NetworkStatus_ListByLocation", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "locationName", + "in": "path", + "description": "Location in which the API Management service is deployed. This is one of the Azure Regions like West US, East US, South Central US.", + "required": true, + "type": "string", + "minLength": 1 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkStatusContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementServiceGetNetworkStatusByLocation": { + "$ref": "./examples/ApiManagementServiceGetNetworkStatusByLocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers": { + "get": { + "operationId": "Logger_ListByService", + "tags": [ + "LoggerContracts" + ], + "description": "Lists a collection of loggers in the specified service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-log-event-hubs" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| loggerType | filter | eq | |
| resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LoggerCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListLoggers": { + "$ref": "./examples/ApiManagementListLoggers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}": { + "get": { + "operationId": "Logger_Get", + "tags": [ + "LoggerContracts" + ], + "description": "Gets the details of the logger specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "loggerId", + "in": "path", + "description": "Logger identifier. Must be unique in the API Management service instance.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetLogger": { + "$ref": "./examples/ApiManagementGetLogger.json" + } + } + }, + "put": { + "operationId": "Logger_CreateOrUpdate", + "tags": [ + "LoggerContracts" + ], + "description": "Creates or Updates a logger.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "loggerId", + "in": "path", + "description": "Logger identifier. Must be unique in the API Management service instance.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LoggerContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateAILogger": { + "$ref": "./examples/ApiManagementCreateAILogger.json" + }, + "ApiManagementCreateEHLogger": { + "$ref": "./examples/ApiManagementCreateEHLogger.json" + } + } + }, + "patch": { + "operationId": "Logger_Update", + "tags": [ + "LoggerContracts" + ], + "description": "Updates an existing logger.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "loggerId", + "in": "path", + "description": "Logger identifier. Must be unique in the API Management service instance.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LoggerUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateLogger": { + "$ref": "./examples/ApiManagementUpdateLogger.json" + } + } + }, + "delete": { + "operationId": "Logger_Delete", + "tags": [ + "LoggerContracts" + ], + "description": "Deletes the specified logger.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "loggerId", + "in": "path", + "description": "Logger identifier. Must be unique in the API Management service instance.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteLogger": { + "$ref": "./examples/ApiManagementDeleteLogger.json" + } + } + }, + "head": { + "operationId": "Logger_GetEntityTag", + "tags": [ + "LoggerContracts" + ], + "description": "Gets the entity state (Etag) version of the logger specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "loggerId", + "in": "path", + "description": "Logger identifier. Must be unique in the API Management service instance.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadLogger": { + "$ref": "./examples/ApiManagementHeadLogger.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/migrateToStv2": { + "post": { + "operationId": "ApiManagementService_MigrateToStv2", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. This is long running operation and could take several minutes to complete.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "parameters", + "in": "body", + "description": "Optional parameters supplied to migrate service.", + "required": false, + "schema": { + "$ref": "#/definitions/MigrateToStv2Contract" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementMigrateService": { + "$ref": "./examples/ApiManagementServiceMigrateToStv2.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/ApiManagementServiceResource" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues": { + "get": { + "operationId": "NamedValue_ListByService", + "tags": [ + "NamedValueContracts" + ], + "description": "Lists a collection of named values defined within a service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "isKeyVaultRefreshFailed", + "in": "query", + "description": "When set to true, the response contains only named value entities which failed refresh.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NamedValueCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListNamedValues": { + "$ref": "./examples/ApiManagementListNamedValues.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}": { + "get": { + "operationId": "NamedValue_Get", + "tags": [ + "NamedValueContracts" + ], + "description": "Gets the details of the named value specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "namedValueId", + "in": "path", + "description": "Identifier of the NamedValue.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetNamedValue": { + "$ref": "./examples/ApiManagementGetNamedValue.json" + }, + "ApiManagementGetNamedValueWithKeyVault": { + "$ref": "./examples/ApiManagementGetNamedValueWithKeyVault.json" + } + } + }, + "put": { + "operationId": "NamedValue_CreateOrUpdate", + "tags": [ + "NamedValueContracts" + ], + "description": "Creates or updates named value.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "namedValueId", + "in": "path", + "description": "Identifier of the NamedValue.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NamedValueCreateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/NamedValueContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/NamedValueContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateNamedValue": { + "$ref": "./examples/ApiManagementCreateNamedValue.json" + }, + "ApiManagementCreateNamedValueWithKeyVault": { + "$ref": "./examples/ApiManagementCreateNamedValueWithKeyVault.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/NamedValueContract" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NamedValue_Update", + "tags": [ + "NamedValueContracts" + ], + "description": "Updates the specific named value.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "namedValueId", + "in": "path", + "description": "Identifier of the NamedValue.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NamedValueUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateNamedValue": { + "$ref": "./examples/ApiManagementUpdateNamedValue.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/NamedValueContract" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NamedValue_Delete", + "tags": [ + "NamedValueContracts" + ], + "description": "Deletes specific named value from the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "namedValueId", + "in": "path", + "description": "Identifier of the NamedValue.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteNamedValue": { + "$ref": "./examples/ApiManagementDeleteNamedValue.json" + } + } + }, + "head": { + "operationId": "NamedValue_GetEntityTag", + "tags": [ + "NamedValueContracts" + ], + "description": "Gets the entity state (Etag) version of the named value specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "namedValueId", + "in": "path", + "description": "Identifier of the NamedValue.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadNamedValue": { + "$ref": "./examples/ApiManagementHeadNamedValue.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}/listValue": { + "post": { + "operationId": "NamedValue_ListValue", + "tags": [ + "NamedValueContracts" + ], + "description": "Gets the secret of the named value specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "namedValueId", + "in": "path", + "description": "Identifier of the NamedValue.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NamedValueSecretContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementNamedValueListValue": { + "$ref": "./examples/ApiManagementNamedValueListValue.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}/refreshSecret": { + "post": { + "operationId": "NamedValue_RefreshSecret", + "tags": [ + "NamedValueContracts" + ], + "description": "Refresh the secret of the named value specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "namedValueId", + "in": "path", + "description": "Identifier of the NamedValue.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementRefreshNamedValue": { + "$ref": "./examples/ApiManagementRefreshNamedValue.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/NamedValueContract" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/networkstatus": { + "get": { + "operationId": "NetworkStatus_ListByService", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkStatusContractByLocation" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementServiceGetNetworkStatus": { + "$ref": "./examples/ApiManagementServiceGetNetworkStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications": { + "get": { + "operationId": "Notification_ListByService", + "tags": [ + "NotificationContracts" + ], + "description": "Lists a collection of properties defined within a service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NotificationCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListNotifications": { + "$ref": "./examples/ApiManagementListNotifications.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}": { + "get": { + "operationId": "Notification_Get", + "tags": [ + "NotificationContracts" + ], + "description": "Gets the details of the Notification specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NotificationContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetNotification": { + "$ref": "./examples/ApiManagementGetNotification.json" + } + } + }, + "put": { + "operationId": "Notification_CreateOrUpdate", + "tags": [ + "NotificationContracts" + ], + "description": "Create or Update API Management publisher notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource 'NotificationContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/NotificationContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateNotification": { + "$ref": "./examples/ApiManagementCreateNotification.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails": { + "get": { + "operationId": "NotificationRecipientEmail_ListByNotification", + "tags": [ + "NotificationContracts" + ], + "description": "Gets the list of the Notification Recipient Emails subscribed to a notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RecipientEmailCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListNotificationRecipientEmails": { + "$ref": "./examples/ApiManagementListNotificationRecipientEmails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}": { + "put": { + "operationId": "NotificationRecipientEmail_CreateOrUpdate", + "tags": [ + "NotificationContracts" + ], + "description": "Adds the Email address to the list of Recipients for the Notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + { + "name": "email", + "in": "path", + "description": "Email identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RecipientEmailContract" + } + }, + "201": { + "description": "Resource 'RecipientEmailContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/RecipientEmailContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementCreateNotificationRecipientEmail.json" + } + } + }, + "delete": { + "operationId": "NotificationRecipientEmail_Delete", + "tags": [ + "NotificationContracts" + ], + "description": "Removes the email from the list of Notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + { + "name": "email", + "in": "path", + "description": "Email identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementDeleteNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementDeleteNotificationRecipientEmail.json" + } + } + }, + "head": { + "operationId": "NotificationRecipientEmail_CheckEntityExists", + "tags": [ + "NotificationContracts" + ], + "description": "Determine if Notification Recipient Email subscribed to the notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + { + "name": "email", + "in": "path", + "description": "Email identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "404": { + "description": "The server cannot find the requested resource." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementHeadNotificationRecipientEmail.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers": { + "get": { + "operationId": "NotificationRecipientUser_ListByNotification", + "tags": [ + "NotificationContracts" + ], + "description": "Gets the list of the Notification Recipient User subscribed to the notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RecipientUserCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListNotificationRecipientUsers": { + "$ref": "./examples/ApiManagementListNotificationRecipientUsers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers/{userId}": { + "put": { + "operationId": "NotificationRecipientUser_CreateOrUpdate", + "tags": [ + "NotificationContracts" + ], + "description": "Adds the API Management User to the list of Recipients for the Notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RecipientUserContract" + } + }, + "201": { + "description": "Resource 'RecipientUserContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/RecipientUserContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateNotificationRecipientUser": { + "$ref": "./examples/ApiManagementCreateNotificationRecipientUser.json" + } + } + }, + "delete": { + "operationId": "NotificationRecipientUser_Delete", + "tags": [ + "NotificationContracts" + ], + "description": "Removes the API Management user from the list of Notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementDeleteNotificationRecipientUser": { + "$ref": "./examples/ApiManagementDeleteNotificationRecipientUser.json" + } + } + }, + "head": { + "operationId": "NotificationRecipientUser_CheckEntityExists", + "tags": [ + "NotificationContracts" + ], + "description": "Determine if the Notification Recipient User is subscribed to the notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "404": { + "description": "The server cannot find the requested resource." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadNotificationRecipientUser": { + "$ref": "./examples/ApiManagementHeadNotificationRecipientUser.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders": { + "get": { + "operationId": "OpenIdConnectProvider_ListByService", + "tags": [ + "OpenidConnectProviderContracts" + ], + "description": "Lists of all the OpenId Connect Providers.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OpenIdConnectProviderCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListOpenIdConnectProviders": { + "$ref": "./examples/ApiManagementListOpenIdConnectProviders.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}": { + "get": { + "operationId": "OpenIdConnectProvider_Get", + "tags": [ + "OpenidConnectProviderContracts" + ], + "description": "Gets specific OpenID Connect Provider without secrets.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "opid", + "in": "path", + "description": "Identifier of the OpenID Connect Provider.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OpenidConnectProviderContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementGetOpenIdConnectProvider.json" + } + } + }, + "put": { + "operationId": "OpenIdConnectProvider_CreateOrUpdate", + "tags": [ + "OpenidConnectProviderContracts" + ], + "description": "Creates or updates the OpenID Connect Provider.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "opid", + "in": "path", + "description": "Identifier of the OpenID Connect Provider.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OpenidConnectProviderContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OpenidConnectProviderContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/OpenidConnectProviderContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementCreateOpenIdConnectProvider.json" + } + } + }, + "patch": { + "operationId": "OpenIdConnectProvider_Update", + "tags": [ + "OpenidConnectProviderContracts" + ], + "description": "Updates the specific OpenID Connect Provider.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "opid", + "in": "path", + "description": "Identifier of the OpenID Connect Provider.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OpenidConnectProviderUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OpenidConnectProviderContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementUpdateOpenIdConnectProvider.json" + } + } + }, + "delete": { + "operationId": "OpenIdConnectProvider_Delete", + "tags": [ + "OpenidConnectProviderContracts" + ], + "description": "Deletes specific OpenID Connect Provider of the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "opid", + "in": "path", + "description": "Identifier of the OpenID Connect Provider.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementDeleteOpenIdConnectProvider.json" + } + } + }, + "head": { + "operationId": "OpenIdConnectProvider_GetEntityTag", + "tags": [ + "OpenidConnectProviderContracts" + ], + "description": "Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "opid", + "in": "path", + "description": "Identifier of the OpenID Connect Provider.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementHeadOpenIdConnectProvider.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}/listSecrets": { + "post": { + "operationId": "OpenIdConnectProvider_ListSecrets", + "tags": [ + "OpenidConnectProviderContracts" + ], + "description": "Gets the client secret details of the OpenID Connect Provider.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "opid", + "in": "path", + "description": "Identifier of the OpenID Connect Provider.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClientSecretContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementOpenidConnectProviderListSecrets": { + "$ref": "./examples/ApiManagementOpenidConnectProviderListSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "operationId": "OutboundNetworkDependenciesEndpoints_ListByService", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Gets the network endpoints of all outbound dependencies of a ApiManagement service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementServiceGetOutboundNetworkDependenciesEndpoints": { + "$ref": "./examples/ApiManagementServiceGetOutboundNetworkDependenciesEndpoints.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies": { + "get": { + "operationId": "Policy_ListByService", + "tags": [ + "Policy" + ], + "description": "Lists all the Global Policy definitions of the Api Management service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PolicyCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListPolicies": { + "$ref": "./examples/ApiManagementListPolicies.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}": { + "get": { + "operationId": "Policy_Get", + "tags": [ + "Policy" + ], + "description": "Get the Global policy definition of the Api Management service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "format", + "in": "query", + "description": "Policy Export Format.", + "required": false, + "type": "string", + "default": "xml", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyExportFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetPolicy": { + "$ref": "./examples/ApiManagementGetPolicy.json" + }, + "ApiManagementGetPolicyFormat": { + "$ref": "./examples/ApiManagementGetPolicyFormat.json" + } + } + }, + "put": { + "operationId": "Policy_CreateOrUpdate", + "tags": [ + "Policy" + ], + "description": "Creates or updates the global policy configuration of the Api Management service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The policy contents to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreatePolicy": { + "$ref": "./examples/ApiManagementCreatePolicy.json" + } + } + }, + "delete": { + "operationId": "Policy_Delete", + "tags": [ + "Policy" + ], + "description": "Deletes the global policy configuration of the Api Management Service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeletePolicy": { + "$ref": "./examples/ApiManagementDeletePolicy.json" + } + } + }, + "head": { + "operationId": "Policy_GetEntityTag", + "tags": [ + "Policy" + ], + "description": "Gets the entity state (Etag) version of the Global policy definition in the Api Management service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadPolicy": { + "$ref": "./examples/ApiManagementHeadPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyDescriptions": { + "get": { + "operationId": "PolicyDescription_ListByService", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists all policy descriptions.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "scope", + "in": "query", + "description": "Policy scope.", + "required": false, + "type": "string", + "enum": [ + "Tenant", + "Product", + "Api", + "Operation", + "All" + ], + "x-ms-enum": { + "name": "PolicyScopeContract", + "modelAsString": false + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PolicyDescriptionCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListPolicyDescriptions": { + "$ref": "./examples/ApiManagementListPolicyDescriptions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments": { + "get": { + "operationId": "PolicyFragment_ListByService", + "tags": [ + "PolicyFragmentContracts" + ], + "description": "Gets all policy fragments.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter, orderBy | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| value | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$orderby", + "in": "query", + "description": "OData order by query option.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PolicyFragmentCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListPolicyFragments": { + "$ref": "./examples/ApiManagementListPolicyFragments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments/{id}": { + "get": { + "operationId": "PolicyFragment_Get", + "tags": [ + "PolicyFragmentContracts" + ], + "description": "Gets a policy fragment.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "id", + "in": "path", + "description": "A resource identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)" + }, + { + "name": "format", + "in": "query", + "description": "Policy fragment content format.", + "required": false, + "type": "string", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyFragmentContentFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyFragmentContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetPolicyFragment": { + "$ref": "./examples/ApiManagementGetPolicyFragment.json" + }, + "ApiManagementGetPolicyFragmentFormat": { + "$ref": "./examples/ApiManagementGetPolicyFragmentFormat.json" + } + } + }, + "put": { + "operationId": "PolicyFragment_CreateOrUpdate", + "tags": [ + "PolicyFragmentContracts" + ], + "description": "Creates or updates a policy fragment.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "id", + "in": "path", + "description": "A resource identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The policy fragment contents to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyFragmentContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyFragmentContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/PolicyFragmentContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreatePolicy": { + "$ref": "./examples/ApiManagementCreatePolicyFragment.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/PolicyFragmentContract" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "PolicyFragment_Delete", + "tags": [ + "PolicyFragmentContracts" + ], + "description": "Deletes a policy fragment.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "id", + "in": "path", + "description": "A resource identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeletePolicy": { + "$ref": "./examples/ApiManagementDeletePolicyFragment.json" + } + } + }, + "head": { + "operationId": "PolicyFragment_GetEntityTag", + "tags": [ + "PolicyFragmentContracts" + ], + "description": "Gets the entity state (Etag) version of a policy fragment.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "id", + "in": "path", + "description": "A resource identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadPolicyFragment": { + "$ref": "./examples/ApiManagementHeadPolicyFragment.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments/{id}/listReferences": { + "post": { + "operationId": "PolicyFragment_ListReferences", + "tags": [ + "PolicyFragmentContracts" + ], + "description": "Lists policy resources that reference the policy fragment.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "id", + "in": "path", + "description": "A resource identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ResourceCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListPolicyFragmentReferences": { + "$ref": "./examples/ApiManagementListPolicyFragmentReferences.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyRestrictions": { + "get": { + "operationId": "PolicyRestriction_ListByService", + "tags": [ + "PolicyRestrictionContracts" + ], + "description": "Gets all policy restrictions of API Management services.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PolicyRestrictionCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListPolicyRestrictions": { + "$ref": "./examples/ApiManagementListPolicyRestrictions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyRestrictions/{policyRestrictionId}": { + "get": { + "operationId": "PolicyRestriction_Get", + "tags": [ + "PolicyRestrictionContracts" + ], + "description": "Get the policy restriction of the Api Management service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "policyRestrictionId", + "in": "path", + "description": "Policy restrictions after an entity level", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyRestrictionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetPolicyRestriction": { + "$ref": "./examples/ApiManagementGetPolicyRestriction.json" + } + } + }, + "put": { + "operationId": "PolicyRestriction_CreateOrUpdate", + "tags": [ + "PolicyRestrictionContracts" + ], + "description": "Creates or updates the policy restriction configuration of the Api Management service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "policyRestrictionId", + "in": "path", + "description": "Policy restrictions after an entity level", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The policy restriction to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyRestrictionContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyRestrictionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version" + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/PolicyRestrictionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreatePolicyRestriction": { + "$ref": "./examples/ApiManagementCreatePolicyRestriction.json" + } + } + }, + "patch": { + "operationId": "PolicyRestriction_Update", + "tags": [ + "PolicyRestrictionContracts" + ], + "description": "Updates the policy restriction configuration of the Api Management service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "policyRestrictionId", + "in": "path", + "description": "Policy restrictions after an entity level", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The policy restriction to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyRestrictionUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyRestrictionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdatePolicyRestriction": { + "$ref": "./examples/ApiManagementUpdatePolicyRestriction.json" + } + } + }, + "delete": { + "operationId": "PolicyRestriction_Delete", + "tags": [ + "PolicyRestrictionContracts" + ], + "description": "Deletes the policy restriction configuration of the Api Management Service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "policyRestrictionId", + "in": "path", + "description": "Policy restrictions after an entity level", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeletePolicyRestriction": { + "$ref": "./examples/ApiManagementDeletePolicyRestriction.json" + } + } + }, + "head": { + "operationId": "PolicyRestriction_GetEntityTag", + "tags": [ + "PolicyRestrictionContracts" + ], + "description": "Gets the entity state (Etag) version of the policy restriction in the Api Management service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "policyRestrictionId", + "in": "path", + "description": "Policy restrictions after an entity level", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadPolicyRestriction": { + "$ref": "./examples/ApiManagementHeadPolicyRestriction.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions": { + "get": { + "operationId": "PortalRevision_ListByService", + "tags": [ + "PortalRevisionContracts" + ], + "description": "Lists developer portal's revisions.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n\n|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|isCurrent | eq, ne | |", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PortalRevisionCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListPortalRevisions": { + "$ref": "./examples/ApiManagementListPortalRevisions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions/{portalRevisionId}": { + "get": { + "operationId": "PortalRevision_Get", + "tags": [ + "PortalRevisionContracts" + ], + "description": "Gets the developer portal's revision specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "portalRevisionId", + "in": "path", + "description": "Portal revision identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PortalRevisionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetPortalRevision": { + "$ref": "./examples/ApiManagementGetPortalRevision.json" + } + } + }, + "put": { + "operationId": "PortalRevision_CreateOrUpdate", + "tags": [ + "PortalRevisionContracts" + ], + "description": "Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "portalRevisionId", + "in": "path", + "description": "Portal revision identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "parameters", + "in": "body", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/PortalRevisionContract" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/PortalRevisionContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreatePortalRevision": { + "$ref": "./examples/ApiManagementCreatePortalRevision.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "PortalRevision_Update", + "tags": [ + "PortalRevisionContracts" + ], + "description": "Updates the description of specified portal revision or makes it current.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "portalRevisionId", + "in": "path", + "description": "Portal revision identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/PortalRevisionContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PortalRevisionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdatePortalRevision": { + "$ref": "./examples/ApiManagementUpdatePortalRevision.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/PortalRevisionContract" + }, + "x-ms-long-running-operation": true + }, + "head": { + "operationId": "PortalRevision_GetEntityTag", + "tags": [ + "PortalRevisionContracts" + ], + "description": "Gets the developer portal revision specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "portalRevisionId", + "in": "path", + "description": "Portal revision identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadPortalRevision": { + "$ref": "./examples/ApiManagementHeadPortalRevision.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs": { + "get": { + "operationId": "PortalConfig_ListByService", + "tags": [ + "PortalConfigContracts" + ], + "description": "Lists the developer portal configurations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PortalConfigCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListPortalConfig": { + "$ref": "./examples/ApiManagementListPortalConfig.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}": { + "get": { + "operationId": "PortalConfig_Get", + "tags": [ + "PortalConfigContracts" + ], + "description": "Get the developer portal configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "portalConfigId", + "in": "path", + "description": "Portal configuration identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PortalConfigContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementPortalConfig": { + "$ref": "./examples/ApiManagementPortalConfig.json" + } + } + }, + "put": { + "operationId": "PortalConfig_CreateOrUpdate", + "tags": [ + "PortalConfigContracts" + ], + "description": "Create or update the developer portal configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "portalConfigId", + "in": "path", + "description": "Portal configuration identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update the developer portal configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/PortalConfigContract" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PortalConfigContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/PortalConfigContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreatePortalConfig": { + "$ref": "./examples/ApiManagementCreatePortalConfig.json" + } + } + }, + "patch": { + "operationId": "PortalConfig_Update", + "tags": [ + "PortalConfigContracts" + ], + "description": "Update the developer portal configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "portalConfigId", + "in": "path", + "description": "Portal configuration identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update the developer portal configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/PortalConfigContract" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PortalConfigContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdatePortalConfig": { + "$ref": "./examples/ApiManagementUpdatePortalConfig.json" + } + } + }, + "head": { + "operationId": "PortalConfig_GetEntityTag", + "tags": [ + "PortalConfigContracts" + ], + "description": "Gets the entity state (Etag) version of the developer portal configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "portalConfigId", + "in": "path", + "description": "Portal configuration identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadPortalConfig": { + "$ref": "./examples/ApiManagementHeadPortalConfig.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings": { + "get": { + "operationId": "PortalSettings_ListByService", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists a collection of portalsettings defined within a service instance..", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PortalSettingsCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementListPortalSettings": { + "$ref": "./examples/ApiManagementListPortalSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/delegation": { + "get": { + "operationId": "DelegationSettings_Get", + "tags": [ + "DelegationSettings" + ], + "description": "Get Delegation Settings for the Portal.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PortalDelegationSettings" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementPortalSettingsGetDelegation": { + "$ref": "./examples/ApiManagementPortalSettingsGetDelegation.json" + } + } + }, + "put": { + "operationId": "DelegationSettings_CreateOrUpdate", + "tags": [ + "DelegationSettings" + ], + "description": "Create or Update Delegation settings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PortalDelegationSettings" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PortalDelegationSettings' update operation succeeded", + "schema": { + "$ref": "#/definitions/PortalDelegationSettings" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateDelegation": { + "$ref": "./examples/ApiManagementPortalSettingsPutDelegation.json" + } + } + }, + "patch": { + "operationId": "DelegationSettings_Update", + "tags": [ + "DelegationSettings" + ], + "description": "Update Delegation settings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update Delegation settings.", + "required": true, + "schema": { + "$ref": "#/definitions/PortalDelegationSettings" + } + } + ], + "responses": { + "204": { + "description": "Operation completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateDelegation": { + "$ref": "./examples/ApiManagementPortalSettingsUpdateDelegation.json" + } + } + }, + "head": { + "operationId": "DelegationSettings_GetEntityTag", + "tags": [ + "DelegationSettings" + ], + "description": "Gets the entity state (Etag) version of the DelegationSettings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementHeadDelegationSettings": { + "$ref": "./examples/ApiManagementHeadDelegationSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/delegation/listSecrets": { + "post": { + "operationId": "DelegationSettings_ListSecrets", + "tags": [ + "DelegationSettings" + ], + "description": "Gets the secret validation key of the DelegationSettings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PortalSettingValidationKeyContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementListSecretsPortalSettings": { + "$ref": "./examples/ApiManagementListSecretsPortalSettingsValidationKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signin": { + "get": { + "operationId": "SignInSettings_Get", + "tags": [ + "SignInSettings" + ], + "description": "Get Sign In Settings for the Portal", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PortalSigninSettings" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementPortalSettingsGetSignIn": { + "$ref": "./examples/ApiManagementPortalSettingsGetSignIn.json" + } + } + }, + "put": { + "operationId": "SignInSettings_CreateOrUpdate", + "tags": [ + "SignInSettings" + ], + "description": "Create or Update Sign-In settings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PortalSigninSettings" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PortalSigninSettings' update operation succeeded", + "schema": { + "$ref": "#/definitions/PortalSigninSettings" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateSignIn": { + "$ref": "./examples/ApiManagementPortalSettingsPutSignIn.json" + } + } + }, + "patch": { + "operationId": "SignInSettings_Update", + "tags": [ + "SignInSettings" + ], + "description": "Update Sign-In settings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update Sign-In settings.", + "required": true, + "schema": { + "$ref": "#/definitions/PortalSigninSettings" + } + } + ], + "responses": { + "204": { + "description": "Operation completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateSignIn": { + "$ref": "./examples/ApiManagementPortalSettingsUpdateSignIn.json" + } + } + }, + "head": { + "operationId": "SignInSettings_GetEntityTag", + "tags": [ + "SignInSettings" + ], + "description": "Gets the entity state (Etag) version of the SignInSettings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementHeadSignInSettings": { + "$ref": "./examples/ApiManagementHeadSignInSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signup": { + "get": { + "operationId": "SignUpSettings_Get", + "tags": [ + "SignUpSettings" + ], + "description": "Get Sign Up Settings for the Portal", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PortalSignupSettings" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementPortalSettingsGetSignUp": { + "$ref": "./examples/ApiManagementPortalSettingsGetSignUp.json" + } + } + }, + "put": { + "operationId": "SignUpSettings_CreateOrUpdate", + "tags": [ + "SignUpSettings" + ], + "description": "Create or Update Sign-Up settings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PortalSignupSettings" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PortalSignupSettings' update operation succeeded", + "schema": { + "$ref": "#/definitions/PortalSignupSettings" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateSignUp": { + "$ref": "./examples/ApiManagementPortalSettingsPutSignUp.json" + } + } + }, + "patch": { + "operationId": "SignUpSettings_Update", + "tags": [ + "SignUpSettings" + ], + "description": "Update Sign-Up settings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update Sign-Up settings.", + "required": true, + "schema": { + "$ref": "#/definitions/PortalSignupSettings" + } + } + ], + "responses": { + "204": { + "description": "Operation completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateSignUp": { + "$ref": "./examples/ApiManagementPortalSettingsUpdateSignUp.json" + } + } + }, + "head": { + "operationId": "SignUpSettings_GetEntityTag", + "tags": [ + "SignUpSettings" + ], + "description": "Gets the entity state (Etag) version of the SignUpSettings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementHeadSignUpSettings": { + "$ref": "./examples/ApiManagementHeadSignUpSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnection_ListByService", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Lists all private endpoint connections of the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure 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-examples": { + "ApiManagementListPrivateEndpointConnections": { + "$ref": "./examples/ApiManagementListPrivateEndpointConnections.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnection_GetByName", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets the details of the Private Endpoint Connection specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetPrivateEndpointConnection": { + "$ref": "./examples/ApiManagementGetPrivateEndpointConnection.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnection_CreateOrUpdate", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Creates a new Private Endpoint Connection or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionRequest", + "in": "body", + "description": "", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionRequest" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnection' update operation succeeded", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementApproveOrRejectPrivateEndpointConnection": { + "$ref": "./examples/ApiManagementApproveOrRejectPrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "PrivateEndpointConnection_Delete", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes the specified 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": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": "Location header" + } + } + }, + "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": { + "ApiManagementDeletePrivateEndpointConnection": { + "$ref": "./examples/ApiManagementDeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateLinkResources": { + "get": { + "operationId": "PrivateEndpointConnection_ListPrivateLinkResources", + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "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": { + "ApiManagementListPrivateLinkGroupResources": { + "$ref": "./examples/ApiManagementListPrivateLinkGroupResources.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateLinkResources/{privateLinkSubResourceName}": { + "get": { + "operationId": "PrivateEndpointConnection_GetPrivateLinkResource", + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "privateLinkSubResourceName", + "in": "path", + "description": "The name of the private link associated with the Azure resource.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetPrivateLinkGroupResource": { + "$ref": "./examples/ApiManagementGetPrivateLinkGroupResource.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products": { + "get": { + "operationId": "Product_ListByService", + "tags": [ + "ProductContracts" + ], + "description": "Lists a collection of products in the specified service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| groups | expand | | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "expandGroups", + "in": "query", + "description": "When set to true, the response contains an array of groups that have visibility to the product. The default is false.", + "required": false, + "type": "boolean" + }, + { + "name": "tags", + "in": "query", + "description": "Products which are part of a specific tag.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProductCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListProducts": { + "$ref": "./examples/ApiManagementListProducts.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}": { + "get": { + "operationId": "Product_Get", + "tags": [ + "ProductContracts" + ], + "description": "Gets the details of the product specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetProduct": { + "$ref": "./examples/ApiManagementGetProduct.json" + } + } + }, + "put": { + "operationId": "Product_CreateOrUpdate", + "tags": [ + "ProductContracts" + ], + "description": "Creates or Updates a product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ProductContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateProduct": { + "$ref": "./examples/ApiManagementCreateProduct.json" + } + } + }, + "patch": { + "operationId": "Product_Update", + "tags": [ + "ProductContracts" + ], + "description": "Update existing product details.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ProductUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateProduct": { + "$ref": "./examples/ApiManagementUpdateProduct.json" + } + } + }, + "delete": { + "operationId": "Product_Delete", + "tags": [ + "ProductContracts" + ], + "description": "Delete product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "deleteSubscriptions", + "in": "query", + "description": "Delete existing subscriptions associated with the product or not.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteProduct": { + "$ref": "./examples/ApiManagementDeleteProduct.json" + } + } + }, + "head": { + "operationId": "Product_GetEntityTag", + "tags": [ + "ProductContracts" + ], + "description": "Gets the entity state (Etag) version of the product specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadProduct": { + "$ref": "./examples/ApiManagementHeadProduct.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apiLinks": { + "get": { + "operationId": "ProductApiLink_ListByProduct", + "tags": [ + "ProductApiLinkContracts" + ], + "description": "Lists a collection of the API links associated with a product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProductApiLinkCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListProductApiLinks": { + "$ref": "./examples/ApiManagementListProductApiLinks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apiLinks/{apiLinkId}": { + "get": { + "operationId": "ProductApiLink_Get", + "tags": [ + "ProductApiLinkContracts" + ], + "description": "Gets the API link for the product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "apiLinkId", + "in": "path", + "description": "Product-API link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductApiLinkContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetProductApiLink": { + "$ref": "./examples/ApiManagementGetProductApiLink.json" + } + } + }, + "put": { + "operationId": "ProductApiLink_CreateOrUpdate", + "tags": [ + "ProductApiLinkContracts" + ], + "description": "Adds an API to the specified product via link.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "apiLinkId", + "in": "path", + "description": "Product-API link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ProductApiLinkContract" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ProductApiLinkContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/ProductApiLinkContract" + } + }, + "201": { + "description": "Resource 'ProductApiLinkContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/ProductApiLinkContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateProductApiLink": { + "$ref": "./examples/ApiManagementCreateProductApiLink.json" + } + } + }, + "delete": { + "operationId": "ProductApiLink_Delete", + "tags": [ + "ProductApiLinkContracts" + ], + "description": "Deletes the specified API from the specified product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "apiLinkId", + "in": "path", + "description": "Product-API link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteProductApiLink": { + "$ref": "./examples/ApiManagementDeleteProductApiLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis": { + "get": { + "operationId": "ProductApi_ListByProduct", + "tags": [ + "ProductContracts" + ], + "description": "Lists a collection of the APIs associated with a product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListProductApis": { + "$ref": "./examples/ApiManagementListProductApis.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}": { + "put": { + "operationId": "ProductApi_CreateOrUpdate", + "tags": [ + "ProductContracts" + ], + "description": "Adds an API to the specified product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiContract" + } + }, + "201": { + "description": "Resource 'ApiContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApiContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateProductApi": { + "$ref": "./examples/ApiManagementCreateProductApi.json" + } + } + }, + "delete": { + "operationId": "ProductApi_Delete", + "tags": [ + "ProductContracts" + ], + "description": "Deletes the specified API from the specified product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementDeleteProductApi": { + "$ref": "./examples/ApiManagementDeleteProductApi.json" + } + } + }, + "head": { + "operationId": "ProductApi_CheckEntityExists", + "tags": [ + "ProductContracts" + ], + "description": "Checks that API entity specified by identifier is associated with the Product entity.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadProductApi": { + "$ref": "./examples/ApiManagementHeadProductApi.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groupLinks": { + "get": { + "operationId": "ProductGroupLink_ListByProduct", + "tags": [ + "ProductGroupLinkContracts" + ], + "description": "Lists a collection of the group links associated with a product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| groupId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProductGroupLinkCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListProductGroupLinks": { + "$ref": "./examples/ApiManagementListProductGroupLinks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groupLinks/{groupLinkId}": { + "get": { + "operationId": "ProductGroupLink_Get", + "tags": [ + "ProductGroupLinkContracts" + ], + "description": "Gets the group link for the product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "groupLinkId", + "in": "path", + "description": "Product-Group link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductGroupLinkContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetProductGroupLink": { + "$ref": "./examples/ApiManagementGetProductGroupLink.json" + } + } + }, + "put": { + "operationId": "ProductGroupLink_CreateOrUpdate", + "tags": [ + "ProductGroupLinkContracts" + ], + "description": "Adds a group to the specified product via link.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "groupLinkId", + "in": "path", + "description": "Product-Group link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ProductGroupLinkContract" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ProductGroupLinkContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/ProductGroupLinkContract" + } + }, + "201": { + "description": "Resource 'ProductGroupLinkContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/ProductGroupLinkContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateProductGroupLink": { + "$ref": "./examples/ApiManagementCreateProductGroupLink.json" + } + } + }, + "delete": { + "operationId": "ProductGroupLink_Delete", + "tags": [ + "ProductGroupLinkContracts" + ], + "description": "Deletes the specified group from the specified product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "groupLinkId", + "in": "path", + "description": "Product-Group link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteProductGroupLink": { + "$ref": "./examples/ApiManagementDeleteProductGroupLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups": { + "get": { + "operationId": "ProductGroup_ListByProduct", + "tags": [ + "ProductContracts" + ], + "description": "Lists the collection of developer groups associated with the specified product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | |
| displayName | filter | eq, ne | |
| description | filter | eq, ne | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GroupCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListProductGroups": { + "$ref": "./examples/ApiManagementListProductGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}": { + "put": { + "operationId": "ProductGroup_CreateOrUpdate", + "tags": [ + "ProductContracts" + ], + "description": "Adds the association between the specified developer group with the specified product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GroupContract" + } + }, + "201": { + "description": "Resource 'GroupContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/GroupContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateProductGroup": { + "$ref": "./examples/ApiManagementCreateProductGroup.json" + } + } + }, + "delete": { + "operationId": "ProductGroup_Delete", + "tags": [ + "ProductContracts" + ], + "description": "Deletes the association between the specified group and product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementDeleteProductGroup": { + "$ref": "./examples/ApiManagementDeleteProductGroup.json" + } + } + }, + "head": { + "operationId": "ProductGroup_CheckEntityExists", + "tags": [ + "ProductContracts" + ], + "description": "Checks that Group entity specified by identifier is associated with the Product entity.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadProductGroup": { + "$ref": "./examples/ApiManagementHeadProductGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies": { + "get": { + "operationId": "ProductPolicy_ListByProduct", + "tags": [ + "ProductPolicy" + ], + "description": "Get the policy configuration at the Product level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PolicyCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListProductPolicies": { + "$ref": "./examples/ApiManagementListProductPolicies.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}": { + "get": { + "operationId": "ProductPolicy_Get", + "tags": [ + "ProductPolicy" + ], + "description": "Get the policy configuration at the Product level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "format", + "in": "query", + "description": "Policy Export Format.", + "required": false, + "type": "string", + "default": "xml", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyExportFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetProductPolicy": { + "$ref": "./examples/ApiManagementGetProductPolicy.json" + } + } + }, + "put": { + "operationId": "ProductPolicy_CreateOrUpdate", + "tags": [ + "ProductPolicy" + ], + "description": "Creates or updates policy configuration for the Product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The policy contents to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateProductPolicy": { + "$ref": "./examples/ApiManagementCreateProductPolicy.json" + } + } + }, + "delete": { + "operationId": "ProductPolicy_Delete", + "tags": [ + "ProductPolicy" + ], + "description": "Deletes the policy configuration at the Product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteProductPolicy": { + "$ref": "./examples/ApiManagementDeleteProductPolicy.json" + } + } + }, + "head": { + "operationId": "ProductPolicy_GetEntityTag", + "tags": [ + "ProductPolicy" + ], + "description": "Get the ETag of the policy configuration at the Product level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadProductPolicy": { + "$ref": "./examples/ApiManagementHeadProductPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions": { + "get": { + "operationId": "ProductSubscriptions_List", + "tags": [ + "ProductContracts" + ], + "description": "Lists the collection of subscriptions to the specified product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SubscriptionCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListProductSubscriptions": { + "$ref": "./examples/ApiManagementListProductSubscriptions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags": { + "get": { + "operationId": "Tag_ListByProduct", + "tags": [ + "TagContractOperation" + ], + "description": "Lists all Tags associated with the Product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListProductTags": { + "$ref": "./examples/ApiManagementListProductTags.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}": { + "get": { + "operationId": "Tag_GetByProduct", + "tags": [ + "TagContractOperation" + ], + "description": "Get tag associated with the Product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetProductTag": { + "$ref": "./examples/ApiManagementGetProductTag.json" + } + } + }, + "put": { + "operationId": "Tag_AssignToProduct", + "tags": [ + "TagContractOperation" + ], + "description": "Assign tag to the Product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource 'TagContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "201": { + "description": "Resource 'TagContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateProductTag": { + "$ref": "./examples/ApiManagementCreateProductTag.json" + } + } + }, + "delete": { + "operationId": "Tag_DetachFromProduct", + "tags": [ + "TagContractOperation" + ], + "description": "Detach the tag from the Product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteProductTag": { + "$ref": "./examples/ApiManagementDeleteProductTag.json" + } + } + }, + "head": { + "operationId": "Tag_GetEntityStateByProduct", + "tags": [ + "TagContractOperation" + ], + "description": "Gets the entity state version of the tag specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadProductTag": { + "$ref": "./examples/ApiManagementHeadProductTag.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/wikis": { + "get": { + "operationId": "ProductWikis_list", + "tags": [ + "ProductWiki" + ], + "description": "Gets the details of the Wiki for a Product specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | eq | contains |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WikiCollection" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiWiki": { + "$ref": "./examples/ApiManagementListProductWikis.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/wikis/default": { + "get": { + "operationId": "ProductWiki_Get", + "tags": [ + "ProductWiki" + ], + "description": "Gets the details of the Wiki for a Product specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetProductWiki": { + "$ref": "./examples/ApiManagementGetProductWiki.json" + } + } + }, + "put": { + "operationId": "ProductWiki_CreateOrUpdate", + "tags": [ + "ProductWiki" + ], + "description": "Creates a new Wiki for a Product or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WikiContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateProductWiki": { + "$ref": "./examples/ApiManagementCreateProductWiki.json" + } + } + }, + "patch": { + "operationId": "ProductWiki_Update", + "tags": [ + "ProductWiki" + ], + "description": "Updates the details of the Wiki for a Product specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Wiki Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WikiUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WikiContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateProductWiki": { + "$ref": "./examples/ApiManagementUpdateProductWiki.json" + } + } + }, + "delete": { + "operationId": "ProductWiki_Delete", + "tags": [ + "ProductWiki" + ], + "description": "Deletes the specified Wiki from a Product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteProductWiki": { + "$ref": "./examples/ApiManagementDeleteProductWiki.json" + } + } + }, + "head": { + "operationId": "ProductWiki_GetEntityTag", + "tags": [ + "ProductWiki" + ], + "description": "Gets the entity state (Etag) version of the Wiki for a Product specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadProductWiki": { + "$ref": "./examples/ApiManagementHeadProductWiki.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/productsByTags": { + "get": { + "operationId": "Product_ListByTags", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists a collection of products associated with 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": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "includeNotTaggedProducts", + "in": "query", + "description": "Include not tagged Products.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagResourceCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListProductsByTags": { + "$ref": "./examples/ApiManagementListProductsByTags.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}": { + "get": { + "operationId": "QuotaByCounterKeys_ListByService", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet.", + "externalDocs": { + "description": "Document describing how to configure the quota policies.", + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "quotaCounterKey", + "in": "path", + "description": "Quota counter key identifier. This is the result of expression defined in `counter-key` attribute of the quota-by-key policy. For example, if you specify `counter-key=\"boo\"` in the policy, then it’s accessible by `\"boo\"` counter key. But if it’s defined as `counter-key=\"@(\"b\"+\"a\")\"` then it will be accessible by `\"ba\"` key.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/QuotaCounterCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetQuotaCounterKeys": { + "$ref": "./examples/ApiManagementGetQuotaCounterKeys.json" + } + } + }, + "patch": { + "operationId": "QuotaByCounterKeys_Update", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "quotaCounterKey", + "in": "path", + "description": "Quota counter key identifier. This is the result of expression defined in `counter-key` attribute of the quota-by-key policy. For example, if you specify `counter-key=\"boo\"` in the policy, then it’s accessible by `\"boo\"` counter key. But if it’s defined as `counter-key=\"@(\"b\"+\"a\")\"` then it will be accessible by `\"ba\"` key.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The value of the quota counter to be applied to all quota counter periods.", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaCounterValueUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/QuotaCounterCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateQuotaCounterKey": { + "$ref": "./examples/ApiManagementUpdateQuotaCounterKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/periods/{quotaPeriodKey}": { + "get": { + "operationId": "QuotaByPeriodKeys_Get", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.", + "externalDocs": { + "description": "Document describing how to configure the quota policies.", + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "quotaCounterKey", + "in": "path", + "description": "Quota counter key identifier. This is the result of expression defined in `counter-key` attribute of the quota-by-key policy. For example, if you specify `counter-key=\"boo\"` in the policy, then it’s accessible by `\"boo\"` counter key. But if it’s defined as `counter-key=\"@(\"b\"+\"a\")\"` then it will be accessible by `\"ba\"` key.", + "required": true, + "type": "string" + }, + { + "name": "quotaPeriodKey", + "in": "path", + "description": "Quota period key identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/QuotaCounterContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetQuotaCounterKeysByQuotaPeriod": { + "$ref": "./examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json" + } + } + }, + "patch": { + "operationId": "QuotaByPeriodKeys_Update", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Updates an existing quota counter value in the specified service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "quotaCounterKey", + "in": "path", + "description": "Quota counter key identifier. This is the result of expression defined in `counter-key` attribute of the quota-by-key policy. For example, if you specify `counter-key=\"boo\"` in the policy, then it’s accessible by `\"boo\"` counter key. But if it’s defined as `counter-key=\"@(\"b\"+\"a\")\"` then it will be accessible by `\"ba\"` key.", + "required": true, + "type": "string" + }, + { + "name": "quotaPeriodKey", + "in": "path", + "description": "Quota period key identifier.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The value of the Quota counter to be applied on the specified period.", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaCounterValueUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/QuotaCounterContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateQuotaCounterKeyByQuotaPeriod": { + "$ref": "./examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions": { + "get": { + "operationId": "Region_ListByService", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists all azure regions in which the service exists.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RegionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListRegions": { + "$ref": "./examples/ApiManagementListRegions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byApi": { + "get": { + "operationId": "Reports_ListByApi", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists report records by API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply on the operation.", + "required": true, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "$orderby", + "in": "query", + "description": "OData order by query option.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetReportsByApi": { + "$ref": "./examples/ApiManagementGetReportsByApi.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byGeo": { + "get": { + "operationId": "Reports_ListByGeo", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists report records by geography.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| country | select | | |
| region | select | | |
| zip | select | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select | | |
| callCountBlocked | select | | |
| callCountFailed | select | | |
| callCountOther | select | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
", + "required": true, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetReportsByGeo": { + "$ref": "./examples/ApiManagementGetReportsByGeo.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byOperation": { + "get": { + "operationId": "Reports_ListByOperation", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists report records by API Operations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | select, filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
", + "required": true, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "$orderby", + "in": "query", + "description": "OData order by query option.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetReportsByOperation": { + "$ref": "./examples/ApiManagementGetReportsByOperation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byProduct": { + "get": { + "operationId": "Reports_ListByProduct", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists report records by Product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | select, filter | eq | |
| subscriptionId | filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
", + "required": true, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "$orderby", + "in": "query", + "description": "OData order by query option.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetReportsByProduct": { + "$ref": "./examples/ApiManagementGetReportsByProduct.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byRequest": { + "get": { + "operationId": "Reports_ListByRequest", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists report records by Request.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| productId | filter | eq | |
| userId | filter | eq | |
| apiRegion | filter | eq | |
| subscriptionId | filter | eq | |
", + "required": true, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RequestReportCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetReportsByRequest": { + "$ref": "./examples/ApiManagementGetReportsByRequest.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/bySubscription": { + "get": { + "operationId": "Reports_ListBySubscription", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists report records by subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| apiRegion | filter | eq | |
| userId | select, filter | eq | |
| productId | select, filter | eq | |
| subscriptionId | select, filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
", + "required": true, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "$orderby", + "in": "query", + "description": "OData order by query option.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetReportsBySubscription": { + "$ref": "./examples/ApiManagementGetReportsBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byTime": { + "get": { + "operationId": "Reports_ListByTime", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists report records by Time.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter, select | ge, le | |
| interval | select | | |
| apiRegion | filter | eq | |
| userId | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select | | |
| callCountBlocked | select | | |
| callCountFailed | select | | |
| callCountOther | select | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
", + "required": true, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "$orderby", + "in": "query", + "description": "OData order by query option.", + "required": false, + "type": "string" + }, + { + "name": "interval", + "in": "query", + "description": "By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).", + "required": true, + "type": "string", + "format": "duration" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetReportsByTime": { + "$ref": "./examples/ApiManagementGetReportsByTime.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byUser": { + "get": { + "operationId": "Reports_ListByUser", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists report records by User.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| timestamp | filter | ge, le | |
| displayName | select, orderBy | | |
| userId | select, filter | eq | |
| apiRegion | filter | eq | |
| productId | filter | eq | |
| subscriptionId | filter | eq | |
| apiId | filter | eq | |
| operationId | filter | eq | |
| callCountSuccess | select, orderBy | | |
| callCountBlocked | select, orderBy | | |
| callCountFailed | select, orderBy | | |
| callCountOther | select, orderBy | | |
| callCountTotal | select, orderBy | | |
| bandwidth | select, orderBy | | |
| cacheHitsCount | select | | |
| cacheMissCount | select | | |
| apiTimeAvg | select, orderBy | | |
| apiTimeMin | select | | |
| apiTimeMax | select | | |
| serviceTimeAvg | select | | |
| serviceTimeMin | select | | |
| serviceTimeMax | select | | |
", + "required": true, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "$orderby", + "in": "query", + "description": "OData order by query option.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetReportsByUser": { + "$ref": "./examples/ApiManagementGetReportsByUser.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore": { + "post": { + "operationId": "ApiManagementService_Restore", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the Restore API Management service from backup operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceBackupRestoreParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementRestoreService": { + "$ref": "./examples/ApiManagementRestoreWithAccessKey.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/ApiManagementServiceResource" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas": { + "get": { + "operationId": "GlobalSchema_ListByService", + "tags": [ + "GlobalSchemaContracts" + ], + "description": "Lists a collection of schemas registered with service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GlobalSchemaCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListSchemas": { + "$ref": "./examples/ApiManagementListGlobalSchemas.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId}": { + "get": { + "operationId": "GlobalSchema_Get", + "tags": [ + "GlobalSchemaContracts" + ], + "description": "Gets the details of the Schema specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GlobalSchemaContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetSchema1": { + "$ref": "./examples/ApiManagementGetGlobalSchema1.json" + }, + "ApiManagementGetSchema2": { + "$ref": "./examples/ApiManagementGetGlobalSchema2.json" + } + } + }, + "put": { + "operationId": "GlobalSchema_CreateOrUpdate", + "tags": [ + "GlobalSchemaContracts" + ], + "description": "Creates new or updates existing specified Schema of the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GlobalSchemaContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GlobalSchemaContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/GlobalSchemaContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateSchema1": { + "$ref": "./examples/ApiManagementCreateGlobalSchema1.json" + }, + "ApiManagementCreateSchema2": { + "$ref": "./examples/ApiManagementCreateGlobalSchema2.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/GlobalSchemaContract" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "GlobalSchema_Delete", + "tags": [ + "GlobalSchemaContracts" + ], + "description": "Deletes specific Schema.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteSchema": { + "$ref": "./examples/ApiManagementDeleteGlobalSchema.json" + } + } + }, + "head": { + "operationId": "GlobalSchema_GetEntityTag", + "tags": [ + "GlobalSchemaContracts" + ], + "description": "Gets the entity state (Etag) version of the Schema specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadApi": { + "$ref": "./examples/ApiManagementHeadGlobalSchema.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings": { + "get": { + "operationId": "TenantSettings_ListByService", + "tags": [ + "TenantSettingsContracts" + ], + "description": "Public settings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "Not used", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TenantSettingsCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementListTenantSettings": { + "$ref": "./examples/ApiManagementListTenantSettings.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings/{settingsType}": { + "get": { + "operationId": "TenantSettings_Get", + "tags": [ + "TenantSettingsContracts" + ], + "description": "Get tenant settings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "settingsType", + "in": "path", + "description": "The identifier of the settings.", + "required": true, + "type": "string", + "enum": [ + "public" + ], + "x-ms-enum": { + "name": "SettingsTypeName", + "modelAsString": true, + "values": [ + { + "name": "public", + "value": "public" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TenantSettingsContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ApiManagementGetTenantSettings": { + "$ref": "./examples/ApiManagementGetTenantSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/skus": { + "get": { + "operationId": "ApiManagementServiceSkus_ListAvailableServiceSkus", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Gets all available SKU for a given API Management service", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ResourceSkuResults" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListSKUs-Consumption": { + "$ref": "./examples/ApiManagementListSKUs-Consumption.json" + }, + "ApiManagementListSKUs-Dedicated": { + "$ref": "./examples/ApiManagementListSKUs-Dedicated.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions": { + "get": { + "operationId": "Subscription_List", + "tags": [ + "SubscriptionContracts" + ], + "description": "Lists all subscriptions of the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SubscriptionCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListSubscriptions": { + "$ref": "./examples/ApiManagementListSubscriptions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}": { + "get": { + "operationId": "Subscription_Get", + "tags": [ + "SubscriptionContracts" + ], + "description": "Gets the specified Subscription entity.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SubscriptionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetSubscription": { + "$ref": "./examples/ApiManagementGetSubscription.json" + } + } + }, + "put": { + "operationId": "Subscription_CreateOrUpdate", + "tags": [ + "SubscriptionContracts" + ], + "description": "Creates or updates the subscription of specified user to the specified product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "notify", + "in": "query", + "description": "Notify change in Subscription State.\n- If false, do not send any email notification for change of state of subscription\n- If true, send email notification of change of state of subscription", + "required": false, + "type": "boolean" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "appType", + "in": "query", + "description": "Determines the type of application which send the create user request. Default is legacy publisher portal.", + "required": false, + "type": "string", + "enum": [ + "portal", + "developerPortal" + ], + "x-ms-enum": { + "name": "AppType", + "modelAsString": true, + "values": [ + { + "name": "portal", + "value": "portal", + "description": "User create request was sent by legacy developer portal." + }, + { + "name": "developerPortal", + "value": "developerPortal", + "description": "User create request was sent by new developer portal." + } + ] + } + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SubscriptionCreateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SubscriptionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/SubscriptionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateSubscription": { + "$ref": "./examples/ApiManagementCreateSubscription.json" + } + } + }, + "patch": { + "operationId": "Subscription_Update", + "tags": [ + "SubscriptionContracts" + ], + "description": "Updates the details of a subscription specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "notify", + "in": "query", + "description": "Notify change in Subscription State.\n- If false, do not send any email notification for change of state of subscription\n- If true, send email notification of change of state of subscription", + "required": false, + "type": "boolean" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "appType", + "in": "query", + "description": "Determines the type of application which send the create user request. Default is legacy publisher portal.", + "required": false, + "type": "string", + "enum": [ + "portal", + "developerPortal" + ], + "x-ms-enum": { + "name": "AppType", + "modelAsString": true, + "values": [ + { + "name": "portal", + "value": "portal", + "description": "User create request was sent by legacy developer portal." + }, + { + "name": "developerPortal", + "value": "developerPortal", + "description": "User create request was sent by new developer portal." + } + ] + } + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SubscriptionUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SubscriptionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateSubscription": { + "$ref": "./examples/ApiManagementUpdateSubscription.json" + } + } + }, + "delete": { + "operationId": "Subscription_Delete", + "tags": [ + "SubscriptionContracts" + ], + "description": "Deletes the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteSubscription": { + "$ref": "./examples/ApiManagementDeleteSubscription.json" + } + } + }, + "head": { + "operationId": "Subscription_GetEntityTag", + "tags": [ + "SubscriptionContracts" + ], + "description": "Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadSubscription": { + "$ref": "./examples/ApiManagementHeadSubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/listSecrets": { + "post": { + "operationId": "Subscription_ListSecrets", + "tags": [ + "SubscriptionContracts" + ], + "description": "Gets the specified Subscription keys.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SubscriptionKeysContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementSubscriptionListSecrets": { + "$ref": "./examples/ApiManagementSubscriptionListSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regeneratePrimaryKey": { + "post": { + "operationId": "Subscription_RegeneratePrimaryKey", + "tags": [ + "SubscriptionContracts" + ], + "description": "Regenerates primary key of existing subscription of the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementSubscriptionRegeneratePrimaryKey": { + "$ref": "./examples/ApiManagementSubscriptionRegeneratePrimaryKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regenerateSecondaryKey": { + "post": { + "operationId": "Subscription_RegenerateSecondaryKey", + "tags": [ + "SubscriptionContracts" + ], + "description": "Regenerates secondary key of existing subscription of the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementSubscriptionRegenerateSecondaryKey": { + "$ref": "./examples/ApiManagementSubscriptionRegenerateSecondaryKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tagResources": { + "get": { + "operationId": "TagResource_ListByService", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Lists a collection of resources associated with 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": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| aid | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| isCurrent | filter | eq | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagResourceCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListTagResources": { + "$ref": "./examples/ApiManagementListTagResources.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags": { + "get": { + "operationId": "Tag_ListByService", + "tags": [ + "TagContractOperationGroup" + ], + "description": "Lists a collection of tags defined within a service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "scope", + "in": "query", + "description": "Scope like 'apis', 'products' or 'apis/{apiId}", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListTags": { + "$ref": "./examples/ApiManagementListTags.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}": { + "get": { + "operationId": "Tag_Get", + "tags": [ + "TagContractOperationGroup" + ], + "description": "Gets the details of the tag specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetTag": { + "$ref": "./examples/ApiManagementGetTag.json" + } + } + }, + "put": { + "operationId": "Tag_CreateOrUpdate", + "tags": [ + "TagContractOperationGroup" + ], + "description": "Creates a tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TagCreateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateTag": { + "$ref": "./examples/ApiManagementCreateTag.json" + } + } + }, + "patch": { + "operationId": "Tag_Update", + "tags": [ + "TagContractOperationGroup" + ], + "description": "Updates the details of the tag specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TagCreateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateTag": { + "$ref": "./examples/ApiManagementUpdateTag.json" + } + } + }, + "delete": { + "operationId": "Tag_Delete", + "tags": [ + "TagContractOperationGroup" + ], + "description": "Deletes specific tag of the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteTag": { + "$ref": "./examples/ApiManagementDeleteTag.json" + } + } + }, + "head": { + "operationId": "Tag_GetEntityState", + "tags": [ + "TagContractOperationGroup" + ], + "description": "Gets the entity state version of the tag specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadTag": { + "$ref": "./examples/ApiManagementHeadTag.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}/apiLinks": { + "get": { + "operationId": "TagApiLink_ListByProduct", + "tags": [ + "TagApiLinkContracts" + ], + "description": "Lists a collection of the API links associated with a tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagApiLinkCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListTagApiLinks": { + "$ref": "./examples/ApiManagementListTagApiLinks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}/apiLinks/{apiLinkId}": { + "get": { + "operationId": "TagApiLink_Get", + "tags": [ + "TagApiLinkContracts" + ], + "description": "Gets the API link for the tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiLinkId", + "in": "path", + "description": "Tag-API link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagApiLinkContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetTagApiLink": { + "$ref": "./examples/ApiManagementGetTagApiLink.json" + } + } + }, + "put": { + "operationId": "TagApiLink_CreateOrUpdate", + "tags": [ + "TagApiLinkContracts" + ], + "description": "Adds an API to the specified tag via link.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiLinkId", + "in": "path", + "description": "Tag-API link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TagApiLinkContract" + } + } + ], + "responses": { + "200": { + "description": "Resource 'TagApiLinkContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/TagApiLinkContract" + } + }, + "201": { + "description": "Resource 'TagApiLinkContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/TagApiLinkContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateTagApiLink": { + "$ref": "./examples/ApiManagementCreateTagApiLink.json" + } + } + }, + "delete": { + "operationId": "TagApiLink_Delete", + "tags": [ + "TagApiLinkContracts" + ], + "description": "Deletes the specified API from the specified tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiLinkId", + "in": "path", + "description": "Tag-API link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteTagApiLink": { + "$ref": "./examples/ApiManagementDeleteTagApiLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}/operationLinks": { + "get": { + "operationId": "TagOperationLink_ListByProduct", + "tags": [ + "TagOperationLinkContracts" + ], + "description": "Lists a collection of the operation links associated with a tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| operationId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagOperationLinkCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListTagOperationLinks": { + "$ref": "./examples/ApiManagementListTagOperationLinks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}/operationLinks/{operationLinkId}": { + "get": { + "operationId": "TagOperationLink_Get", + "tags": [ + "TagOperationLinkContracts" + ], + "description": "Gets the operation link for the tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationLinkId", + "in": "path", + "description": "Tag-operation link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagOperationLinkContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetTagOperationLink": { + "$ref": "./examples/ApiManagementGetTagOperationLink.json" + } + } + }, + "put": { + "operationId": "TagOperationLink_CreateOrUpdate", + "tags": [ + "TagOperationLinkContracts" + ], + "description": "Adds an operation to the specified tag via link.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationLinkId", + "in": "path", + "description": "Tag-operation link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TagOperationLinkContract" + } + } + ], + "responses": { + "200": { + "description": "Resource 'TagOperationLinkContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/TagOperationLinkContract" + } + }, + "201": { + "description": "Resource 'TagOperationLinkContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/TagOperationLinkContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateTagOperationLink": { + "$ref": "./examples/ApiManagementCreateTagOperationLink.json" + } + } + }, + "delete": { + "operationId": "TagOperationLink_Delete", + "tags": [ + "TagOperationLinkContracts" + ], + "description": "Deletes the specified operation from the specified tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationLinkId", + "in": "path", + "description": "Tag-operation link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteTagOperationLink": { + "$ref": "./examples/ApiManagementDeleteTagOperationLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}/productLinks": { + "get": { + "operationId": "TagProductLink_ListByProduct", + "tags": [ + "TagProductLinkContracts" + ], + "description": "Lists a collection of the product links associated with a tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagProductLinkCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListTagProductLinks": { + "$ref": "./examples/ApiManagementListTagProductLinks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}/productLinks/{productLinkId}": { + "get": { + "operationId": "TagProductLink_Get", + "tags": [ + "TagProductLinkContracts" + ], + "description": "Gets the product link for the tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productLinkId", + "in": "path", + "description": "Tag-product link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagProductLinkContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetTagProductLink": { + "$ref": "./examples/ApiManagementGetTagProductLink.json" + } + } + }, + "put": { + "operationId": "TagProductLink_CreateOrUpdate", + "tags": [ + "TagProductLinkContracts" + ], + "description": "Adds a product to the specified tag via link.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productLinkId", + "in": "path", + "description": "Tag-product link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TagProductLinkContract" + } + } + ], + "responses": { + "200": { + "description": "Resource 'TagProductLinkContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/TagProductLinkContract" + } + }, + "201": { + "description": "Resource 'TagProductLinkContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/TagProductLinkContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateTagProductLink": { + "$ref": "./examples/ApiManagementCreateTagProductLink.json" + } + } + }, + "delete": { + "operationId": "TagProductLink_Delete", + "tags": [ + "TagProductLinkContracts" + ], + "description": "Deletes the specified product from the specified tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productLinkId", + "in": "path", + "description": "Tag-product link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteTagProductLink": { + "$ref": "./examples/ApiManagementDeleteTagProductLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates": { + "get": { + "operationId": "EmailTemplate_ListByService", + "tags": [ + "EmailTemplateContracts" + ], + "description": "Gets all email templates", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EmailTemplateCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListTemplates": { + "$ref": "./examples/ApiManagementListTemplates.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}": { + "get": { + "operationId": "EmailTemplate_Get", + "tags": [ + "EmailTemplateContracts" + ], + "description": "Gets the details of the email template specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "templateName", + "in": "path", + "description": "Email Template Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "applicationApprovedNotificationMessage", + "accountClosedDeveloper", + "quotaLimitApproachingDeveloperNotificationMessage", + "newDeveloperNotificationMessage", + "emailChangeIdentityDefault", + "inviteUserNotificationMessage", + "newCommentNotificationMessage", + "confirmSignUpIdentityDefault", + "newIssueNotificationMessage", + "purchaseDeveloperNotificationMessage", + "passwordResetIdentityDefault", + "passwordResetByAdminNotificationMessage", + "rejectDeveloperNotificationMessage", + "requestDeveloperNotificationMessage" + ], + "x-ms-enum": { + "name": "TemplateName", + "modelAsString": true, + "values": [ + { + "name": "applicationApprovedNotificationMessage", + "value": "applicationApprovedNotificationMessage" + }, + { + "name": "accountClosedDeveloper", + "value": "accountClosedDeveloper" + }, + { + "name": "quotaLimitApproachingDeveloperNotificationMessage", + "value": "quotaLimitApproachingDeveloperNotificationMessage" + }, + { + "name": "newDeveloperNotificationMessage", + "value": "newDeveloperNotificationMessage" + }, + { + "name": "emailChangeIdentityDefault", + "value": "emailChangeIdentityDefault" + }, + { + "name": "inviteUserNotificationMessage", + "value": "inviteUserNotificationMessage" + }, + { + "name": "newCommentNotificationMessage", + "value": "newCommentNotificationMessage" + }, + { + "name": "confirmSignUpIdentityDefault", + "value": "confirmSignUpIdentityDefault" + }, + { + "name": "newIssueNotificationMessage", + "value": "newIssueNotificationMessage" + }, + { + "name": "purchaseDeveloperNotificationMessage", + "value": "purchaseDeveloperNotificationMessage" + }, + { + "name": "passwordResetIdentityDefault", + "value": "passwordResetIdentityDefault" + }, + { + "name": "passwordResetByAdminNotificationMessage", + "value": "passwordResetByAdminNotificationMessage" + }, + { + "name": "rejectDeveloperNotificationMessage", + "value": "rejectDeveloperNotificationMessage" + }, + { + "name": "requestDeveloperNotificationMessage", + "value": "requestDeveloperNotificationMessage" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EmailTemplateContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetTemplate": { + "$ref": "./examples/ApiManagementGetTemplate.json" + } + } + }, + "put": { + "operationId": "EmailTemplate_CreateOrUpdate", + "tags": [ + "EmailTemplateContracts" + ], + "description": "Updates an Email Template.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "templateName", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "enum": [ + "applicationApprovedNotificationMessage", + "accountClosedDeveloper", + "quotaLimitApproachingDeveloperNotificationMessage", + "newDeveloperNotificationMessage", + "emailChangeIdentityDefault", + "inviteUserNotificationMessage", + "newCommentNotificationMessage", + "confirmSignUpIdentityDefault", + "newIssueNotificationMessage", + "purchaseDeveloperNotificationMessage", + "passwordResetIdentityDefault", + "passwordResetByAdminNotificationMessage", + "rejectDeveloperNotificationMessage", + "requestDeveloperNotificationMessage" + ], + "x-ms-enum": { + "name": "TemplateName", + "modelAsString": true, + "values": [ + { + "name": "applicationApprovedNotificationMessage", + "value": "applicationApprovedNotificationMessage" + }, + { + "name": "accountClosedDeveloper", + "value": "accountClosedDeveloper" + }, + { + "name": "quotaLimitApproachingDeveloperNotificationMessage", + "value": "quotaLimitApproachingDeveloperNotificationMessage" + }, + { + "name": "newDeveloperNotificationMessage", + "value": "newDeveloperNotificationMessage" + }, + { + "name": "emailChangeIdentityDefault", + "value": "emailChangeIdentityDefault" + }, + { + "name": "inviteUserNotificationMessage", + "value": "inviteUserNotificationMessage" + }, + { + "name": "newCommentNotificationMessage", + "value": "newCommentNotificationMessage" + }, + { + "name": "confirmSignUpIdentityDefault", + "value": "confirmSignUpIdentityDefault" + }, + { + "name": "newIssueNotificationMessage", + "value": "newIssueNotificationMessage" + }, + { + "name": "purchaseDeveloperNotificationMessage", + "value": "purchaseDeveloperNotificationMessage" + }, + { + "name": "passwordResetIdentityDefault", + "value": "passwordResetIdentityDefault" + }, + { + "name": "passwordResetByAdminNotificationMessage", + "value": "passwordResetByAdminNotificationMessage" + }, + { + "name": "rejectDeveloperNotificationMessage", + "value": "rejectDeveloperNotificationMessage" + }, + { + "name": "requestDeveloperNotificationMessage", + "value": "requestDeveloperNotificationMessage" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Email Template update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EmailTemplateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EmailTemplateContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/EmailTemplateContract" + } + }, + "201": { + "description": "Resource 'EmailTemplateContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/EmailTemplateContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateTemplate": { + "$ref": "./examples/ApiManagementCreateTemplate.json" + } + } + }, + "patch": { + "operationId": "EmailTemplate_Update", + "tags": [ + "EmailTemplateContracts" + ], + "description": "Updates API Management email template", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "templateName", + "in": "path", + "description": "Email Template Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "applicationApprovedNotificationMessage", + "accountClosedDeveloper", + "quotaLimitApproachingDeveloperNotificationMessage", + "newDeveloperNotificationMessage", + "emailChangeIdentityDefault", + "inviteUserNotificationMessage", + "newCommentNotificationMessage", + "confirmSignUpIdentityDefault", + "newIssueNotificationMessage", + "purchaseDeveloperNotificationMessage", + "passwordResetIdentityDefault", + "passwordResetByAdminNotificationMessage", + "rejectDeveloperNotificationMessage", + "requestDeveloperNotificationMessage" + ], + "x-ms-enum": { + "name": "TemplateName", + "modelAsString": true, + "values": [ + { + "name": "applicationApprovedNotificationMessage", + "value": "applicationApprovedNotificationMessage" + }, + { + "name": "accountClosedDeveloper", + "value": "accountClosedDeveloper" + }, + { + "name": "quotaLimitApproachingDeveloperNotificationMessage", + "value": "quotaLimitApproachingDeveloperNotificationMessage" + }, + { + "name": "newDeveloperNotificationMessage", + "value": "newDeveloperNotificationMessage" + }, + { + "name": "emailChangeIdentityDefault", + "value": "emailChangeIdentityDefault" + }, + { + "name": "inviteUserNotificationMessage", + "value": "inviteUserNotificationMessage" + }, + { + "name": "newCommentNotificationMessage", + "value": "newCommentNotificationMessage" + }, + { + "name": "confirmSignUpIdentityDefault", + "value": "confirmSignUpIdentityDefault" + }, + { + "name": "newIssueNotificationMessage", + "value": "newIssueNotificationMessage" + }, + { + "name": "purchaseDeveloperNotificationMessage", + "value": "purchaseDeveloperNotificationMessage" + }, + { + "name": "passwordResetIdentityDefault", + "value": "passwordResetIdentityDefault" + }, + { + "name": "passwordResetByAdminNotificationMessage", + "value": "passwordResetByAdminNotificationMessage" + }, + { + "name": "rejectDeveloperNotificationMessage", + "value": "rejectDeveloperNotificationMessage" + }, + { + "name": "requestDeveloperNotificationMessage", + "value": "requestDeveloperNotificationMessage" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EmailTemplateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EmailTemplateContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateTemplate": { + "$ref": "./examples/ApiManagementUpdateTemplate.json" + } + } + }, + "delete": { + "operationId": "EmailTemplate_Delete", + "tags": [ + "EmailTemplateContracts" + ], + "description": "Reset the Email Template to default template provided by the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "templateName", + "in": "path", + "description": "Email Template Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "applicationApprovedNotificationMessage", + "accountClosedDeveloper", + "quotaLimitApproachingDeveloperNotificationMessage", + "newDeveloperNotificationMessage", + "emailChangeIdentityDefault", + "inviteUserNotificationMessage", + "newCommentNotificationMessage", + "confirmSignUpIdentityDefault", + "newIssueNotificationMessage", + "purchaseDeveloperNotificationMessage", + "passwordResetIdentityDefault", + "passwordResetByAdminNotificationMessage", + "rejectDeveloperNotificationMessage", + "requestDeveloperNotificationMessage" + ], + "x-ms-enum": { + "name": "TemplateName", + "modelAsString": true, + "values": [ + { + "name": "applicationApprovedNotificationMessage", + "value": "applicationApprovedNotificationMessage" + }, + { + "name": "accountClosedDeveloper", + "value": "accountClosedDeveloper" + }, + { + "name": "quotaLimitApproachingDeveloperNotificationMessage", + "value": "quotaLimitApproachingDeveloperNotificationMessage" + }, + { + "name": "newDeveloperNotificationMessage", + "value": "newDeveloperNotificationMessage" + }, + { + "name": "emailChangeIdentityDefault", + "value": "emailChangeIdentityDefault" + }, + { + "name": "inviteUserNotificationMessage", + "value": "inviteUserNotificationMessage" + }, + { + "name": "newCommentNotificationMessage", + "value": "newCommentNotificationMessage" + }, + { + "name": "confirmSignUpIdentityDefault", + "value": "confirmSignUpIdentityDefault" + }, + { + "name": "newIssueNotificationMessage", + "value": "newIssueNotificationMessage" + }, + { + "name": "purchaseDeveloperNotificationMessage", + "value": "purchaseDeveloperNotificationMessage" + }, + { + "name": "passwordResetIdentityDefault", + "value": "passwordResetIdentityDefault" + }, + { + "name": "passwordResetByAdminNotificationMessage", + "value": "passwordResetByAdminNotificationMessage" + }, + { + "name": "rejectDeveloperNotificationMessage", + "value": "rejectDeveloperNotificationMessage" + }, + { + "name": "requestDeveloperNotificationMessage", + "value": "requestDeveloperNotificationMessage" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteTemplate": { + "$ref": "./examples/ApiManagementDeleteTemplate.json" + } + } + }, + "head": { + "operationId": "EmailTemplate_GetEntityTag", + "tags": [ + "EmailTemplateContracts" + ], + "description": "Gets the entity state (Etag) version of the email template specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "templateName", + "in": "path", + "description": "Email Template Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "applicationApprovedNotificationMessage", + "accountClosedDeveloper", + "quotaLimitApproachingDeveloperNotificationMessage", + "newDeveloperNotificationMessage", + "emailChangeIdentityDefault", + "inviteUserNotificationMessage", + "newCommentNotificationMessage", + "confirmSignUpIdentityDefault", + "newIssueNotificationMessage", + "purchaseDeveloperNotificationMessage", + "passwordResetIdentityDefault", + "passwordResetByAdminNotificationMessage", + "rejectDeveloperNotificationMessage", + "requestDeveloperNotificationMessage" + ], + "x-ms-enum": { + "name": "TemplateName", + "modelAsString": true, + "values": [ + { + "name": "applicationApprovedNotificationMessage", + "value": "applicationApprovedNotificationMessage" + }, + { + "name": "accountClosedDeveloper", + "value": "accountClosedDeveloper" + }, + { + "name": "quotaLimitApproachingDeveloperNotificationMessage", + "value": "quotaLimitApproachingDeveloperNotificationMessage" + }, + { + "name": "newDeveloperNotificationMessage", + "value": "newDeveloperNotificationMessage" + }, + { + "name": "emailChangeIdentityDefault", + "value": "emailChangeIdentityDefault" + }, + { + "name": "inviteUserNotificationMessage", + "value": "inviteUserNotificationMessage" + }, + { + "name": "newCommentNotificationMessage", + "value": "newCommentNotificationMessage" + }, + { + "name": "confirmSignUpIdentityDefault", + "value": "confirmSignUpIdentityDefault" + }, + { + "name": "newIssueNotificationMessage", + "value": "newIssueNotificationMessage" + }, + { + "name": "purchaseDeveloperNotificationMessage", + "value": "purchaseDeveloperNotificationMessage" + }, + { + "name": "passwordResetIdentityDefault", + "value": "passwordResetIdentityDefault" + }, + { + "name": "passwordResetByAdminNotificationMessage", + "value": "passwordResetByAdminNotificationMessage" + }, + { + "name": "rejectDeveloperNotificationMessage", + "value": "rejectDeveloperNotificationMessage" + }, + { + "name": "requestDeveloperNotificationMessage", + "value": "requestDeveloperNotificationMessage" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadEmailTemplate": { + "$ref": "./examples/ApiManagementHeadEmailTemplate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant": { + "get": { + "operationId": "TenantAccess_ListByService", + "tags": [ + "AccessInformationContracts" + ], + "description": "Returns list of access infos - for Git and Management endpoints.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "Not used", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccessInformationCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListTenantAccess": { + "$ref": "./examples/ApiManagementListTenantAccess.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}": { + "get": { + "operationId": "TenantAccess_Get", + "tags": [ + "AccessInformationContracts" + ], + "description": "Get tenant access information details without secrets.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "accessName", + "in": "path", + "description": "The identifier of the Access configuration.", + "required": true, + "type": "string", + "enum": [ + "access", + "gitAccess" + ], + "x-ms-enum": { + "name": "AccessIdName", + "modelAsString": true, + "values": [ + { + "name": "access", + "value": "access" + }, + { + "name": "gitAccess", + "value": "gitAccess" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AccessInformationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetTenantAccess": { + "$ref": "./examples/ApiManagementGetTenantAccess.json" + }, + "ApiManagementGetTenantGitAccess": { + "$ref": "./examples/ApiManagementGetTenantGitAccess.json" + } + } + }, + "put": { + "operationId": "TenantAccess_Create", + "tags": [ + "AccessInformationContracts" + ], + "description": "Update tenant access information details.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "accessName", + "in": "path", + "description": "The identifier of the Access configuration.", + "required": true, + "type": "string", + "enum": [ + "access", + "gitAccess" + ], + "x-ms-enum": { + "name": "AccessIdName", + "modelAsString": true, + "values": [ + { + "name": "access", + "value": "access" + }, + { + "name": "gitAccess", + "value": "gitAccess" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to retrieve the Tenant Access Information.", + "required": true, + "schema": { + "$ref": "#/definitions/AccessInformationCreateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AccessInformationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateTenantAccess": { + "$ref": "./examples/ApiManagementCreateTenantAccess.json" + } + } + }, + "patch": { + "operationId": "TenantAccess_Update", + "tags": [ + "AccessInformationContracts" + ], + "description": "Update tenant access information details.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "accessName", + "in": "path", + "description": "The identifier of the Access configuration.", + "required": true, + "type": "string", + "enum": [ + "access", + "gitAccess" + ], + "x-ms-enum": { + "name": "AccessIdName", + "modelAsString": true, + "values": [ + { + "name": "access", + "value": "access" + }, + { + "name": "gitAccess", + "value": "gitAccess" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to retrieve the Tenant Access Information.", + "required": true, + "schema": { + "$ref": "#/definitions/AccessInformationUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AccessInformationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateTenantAccess": { + "$ref": "./examples/ApiManagementUpdateTenantAccess.json" + } + } + }, + "head": { + "operationId": "TenantAccess_GetEntityTag", + "tags": [ + "AccessInformationContracts" + ], + "description": "Tenant access metadata", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "accessName", + "in": "path", + "description": "The identifier of the Access configuration.", + "required": true, + "type": "string", + "enum": [ + "access", + "gitAccess" + ], + "x-ms-enum": { + "name": "AccessIdName", + "modelAsString": true, + "values": [ + { + "name": "access", + "value": "access" + }, + { + "name": "gitAccess", + "value": "gitAccess" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadTenantAccess": { + "$ref": "./examples/ApiManagementHeadTenantAccess.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/deploy": { + "post": { + "operationId": "TenantConfiguration_Deploy", + "tags": [ + "AccessInformationContracts" + ], + "description": "This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.", + "externalDocs": { + "description": "To deploy any service configuration changes to the API Management service instance", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-configuration-repository-git/#to-deploy-any-service-configuration-changes-to-the-api-management-service-instance" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "configurationName", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "enum": [ + "configuration" + ], + "x-ms-enum": { + "name": "ConfigurationIdName", + "modelAsString": true, + "values": [ + { + "name": "configuration", + "value": "configuration" + } + ] + } + }, + { + "name": "parameters", + "in": "body", + "description": "Deploy Configuration parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DeployConfigurationParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationResultContract" + } + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementTenantConfigurationDeploy": { + "$ref": "./examples/ApiManagementTenantConfigurationDeploy.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/OperationResultContract" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/git/regeneratePrimaryKey": { + "post": { + "operationId": "TenantAccessGit_RegeneratePrimaryKey", + "tags": [ + "AccessInformationContracts" + ], + "description": "Regenerate primary access key for GIT.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "accessName", + "in": "path", + "description": "The identifier of the Access configuration.", + "required": true, + "type": "string", + "enum": [ + "access", + "gitAccess" + ], + "x-ms-enum": { + "name": "AccessIdName", + "modelAsString": true, + "values": [ + { + "name": "access", + "value": "access" + }, + { + "name": "gitAccess", + "value": "gitAccess" + } + ] + } + } + ], + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementTenantAccessRegenerateKey": { + "$ref": "./examples/ApiManagementTenantAccessRegenerateSecondaryKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/git/regenerateSecondaryKey": { + "post": { + "operationId": "TenantAccessGit_RegenerateSecondaryKey", + "tags": [ + "AccessInformationContracts" + ], + "description": "Regenerate secondary access key for GIT.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "accessName", + "in": "path", + "description": "The identifier of the Access configuration.", + "required": true, + "type": "string", + "enum": [ + "access", + "gitAccess" + ], + "x-ms-enum": { + "name": "AccessIdName", + "modelAsString": true, + "values": [ + { + "name": "access", + "value": "access" + }, + { + "name": "gitAccess", + "value": "gitAccess" + } + ] + } + } + ], + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementTenantAccessRegenerateKey": { + "$ref": "./examples/ApiManagementTenantAccessGitRegenerateSecondaryKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/listSecrets": { + "post": { + "operationId": "TenantAccess_ListSecrets", + "tags": [ + "AccessInformationContracts" + ], + "description": "Get tenant access information details.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "accessName", + "in": "path", + "description": "The identifier of the Access configuration.", + "required": true, + "type": "string", + "enum": [ + "access", + "gitAccess" + ], + "x-ms-enum": { + "name": "AccessIdName", + "modelAsString": true, + "values": [ + { + "name": "access", + "value": "access" + }, + { + "name": "gitAccess", + "value": "gitAccess" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccessInformationSecretsContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListSecretsTenantAccess": { + "$ref": "./examples/ApiManagementListSecretsTenantAccess.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/regeneratePrimaryKey": { + "post": { + "operationId": "TenantAccess_RegeneratePrimaryKey", + "tags": [ + "AccessInformationContracts" + ], + "description": "Regenerate primary access key", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "accessName", + "in": "path", + "description": "The identifier of the Access configuration.", + "required": true, + "type": "string", + "enum": [ + "access", + "gitAccess" + ], + "x-ms-enum": { + "name": "AccessIdName", + "modelAsString": true, + "values": [ + { + "name": "access", + "value": "access" + }, + { + "name": "gitAccess", + "value": "gitAccess" + } + ] + } + } + ], + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementTenantAccessRegenerateKey": { + "$ref": "./examples/ApiManagementTenantAccessRegeneratePrimaryKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/regenerateSecondaryKey": { + "post": { + "operationId": "TenantAccess_RegenerateSecondaryKey", + "tags": [ + "AccessInformationContracts" + ], + "description": "Regenerate secondary access key", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "accessName", + "in": "path", + "description": "The identifier of the Access configuration.", + "required": true, + "type": "string", + "enum": [ + "access", + "gitAccess" + ], + "x-ms-enum": { + "name": "AccessIdName", + "modelAsString": true, + "values": [ + { + "name": "access", + "value": "access" + }, + { + "name": "gitAccess", + "value": "gitAccess" + } + ] + } + } + ], + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementTenantAccessRegenerateKey": { + "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/save": { + "post": { + "operationId": "TenantConfiguration_Save", + "tags": [ + "AccessInformationContracts" + ], + "description": "This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.", + "externalDocs": { + "description": "To save the service configuration to the Git repository", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-configuration-repository-git/#to-save-the-service-configuration-to-the-git-repository" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "configurationName", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "enum": [ + "configuration" + ], + "x-ms-enum": { + "name": "ConfigurationIdName", + "modelAsString": true, + "values": [ + { + "name": "configuration", + "value": "configuration" + } + ] + } + }, + { + "name": "parameters", + "in": "body", + "description": "Save Configuration parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SaveConfigurationParameter" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationResultContract" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementTenantConfigurationSave": { + "$ref": "./examples/ApiManagementTenantConfigurationSave.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/OperationResultContract" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/syncState": { + "get": { + "operationId": "TenantConfiguration_GetSyncState", + "tags": [ + "AccessInformationContracts" + ], + "description": "Gets the status of the most recent synchronization between the configuration database and the Git repository.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "configurationName", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "enum": [ + "configuration" + ], + "x-ms-enum": { + "name": "ConfigurationIdName", + "modelAsString": true, + "values": [ + { + "name": "configuration", + "value": "configuration" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TenantConfigurationSyncStateContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementTenantAccessSyncState": { + "$ref": "./examples/ApiManagementTenantAccessSyncState.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/validate": { + "post": { + "operationId": "TenantConfiguration_Validate", + "tags": [ + "AccessInformationContracts" + ], + "description": "This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "configurationName", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "enum": [ + "configuration" + ], + "x-ms-enum": { + "name": "ConfigurationIdName", + "modelAsString": true, + "values": [ + { + "name": "configuration", + "value": "configuration" + } + ] + } + }, + { + "name": "parameters", + "in": "body", + "description": "Validate Configuration parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DeployConfigurationParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationResultContract" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementTenantConfigurationValidate": { + "$ref": "./examples/ApiManagementTenantConfigurationValidate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/OperationResultContract" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users": { + "get": { + "operationId": "User_ListByService", + "tags": [ + "UserContracts" + ], + "description": "Lists a collection of registered users in the specified service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| groups | expand | | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "expandGroups", + "in": "query", + "description": "Detailed Group in response.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UserCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListUsers": { + "$ref": "./examples/ApiManagementListUsers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}": { + "get": { + "operationId": "User_Get", + "tags": [ + "UserContracts" + ], + "description": "Gets the details of the user specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/UserContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetUser": { + "$ref": "./examples/ApiManagementGetUser.json" + } + } + }, + "put": { + "operationId": "User_CreateOrUpdate", + "tags": [ + "UserContracts" + ], + "description": "Creates or Updates a user.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "userId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "notify", + "in": "query", + "description": "Send an Email notification to the User.", + "required": false, + "type": "boolean" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/UserCreateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/UserContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/UserContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateUser": { + "$ref": "./examples/ApiManagementCreateUser.json" + } + } + }, + "patch": { + "operationId": "User_Update", + "tags": [ + "UserContracts" + ], + "description": "Updates the details of the user specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/UserUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/UserContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateUser": { + "$ref": "./examples/ApiManagementUpdateUser.json" + } + } + }, + "delete": { + "operationId": "User_Delete", + "tags": [ + "UserContracts" + ], + "description": "Deletes specific user.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "deleteSubscriptions", + "in": "query", + "description": "Whether to delete user's subscription or not.", + "required": false, + "type": "boolean" + }, + { + "name": "notify", + "in": "query", + "description": "Send an Account Closed Email notification to the User.", + "required": false, + "type": "boolean" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "appType", + "in": "query", + "description": "Determines the type of application which send the create user request. Default is legacy publisher portal.", + "required": false, + "type": "string", + "enum": [ + "portal", + "developerPortal" + ], + "x-ms-enum": { + "name": "AppType", + "modelAsString": true, + "values": [ + { + "name": "portal", + "value": "portal", + "description": "User create request was sent by legacy developer portal." + }, + { + "name": "developerPortal", + "value": "developerPortal", + "description": "User create request was sent by new developer portal." + } + ] + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementDeleteUser": { + "$ref": "./examples/ApiManagementDeleteUser.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "head": { + "operationId": "User_GetEntityTag", + "tags": [ + "UserContracts" + ], + "description": "Gets the entity state (Etag) version of the user specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadUser": { + "$ref": "./examples/ApiManagementHeadUser.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/confirmations/password/send": { + "post": { + "operationId": "UserConfirmationPassword_Send", + "tags": [ + "UserContracts" + ], + "description": "Sends confirmation", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "appType", + "in": "query", + "description": "Determines the type of application which send the create user request. Default is legacy publisher portal.", + "required": false, + "type": "string", + "enum": [ + "portal", + "developerPortal" + ], + "x-ms-enum": { + "name": "AppType", + "modelAsString": true, + "values": [ + { + "name": "portal", + "value": "portal", + "description": "User create request was sent by legacy developer portal." + }, + { + "name": "developerPortal", + "value": "developerPortal", + "description": "User create request was sent by new developer portal." + } + ] + } + } + ], + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUserConfirmationPasswordSend": { + "$ref": "./examples/ApiManagementUserConfirmationPasswordSend.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/generateSsoUrl": { + "post": { + "operationId": "User_GenerateSsoUrl", + "tags": [ + "UserContracts" + ], + "description": "Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GenerateSsoUrlResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUserGenerateSsoUrl": { + "$ref": "./examples/ApiManagementUserGenerateSsoUrl.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/groups": { + "get": { + "operationId": "UserGroup_List", + "tags": [ + "UserContracts" + ], + "description": "Lists all user groups.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|------------------------|-----------------------------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GroupCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListUserGroups": { + "$ref": "./examples/ApiManagementListUserGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/identities": { + "get": { + "operationId": "UserIdentities_List", + "tags": [ + "UserContracts" + ], + "description": "List of all user identities.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UserIdentityCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListUserIdentities": { + "$ref": "./examples/ApiManagementListUserIdentities.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions": { + "get": { + "operationId": "UserSubscription_List", + "tags": [ + "UserSubscription" + ], + "description": "Lists the collection of subscriptions of the specified user.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|------------------------|-----------------------------------|
|name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SubscriptionCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListUserSubscriptions": { + "$ref": "./examples/ApiManagementListUserSubscriptions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions/{sid}": { + "get": { + "operationId": "UserSubscription_Get", + "tags": [ + "UserSubscription" + ], + "description": "Gets the specified Subscription entity associated with a particular user.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SubscriptionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetUserSubscription": { + "$ref": "./examples/ApiManagementGetUserSubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/token": { + "post": { + "operationId": "User_GetSharedAccessToken", + "tags": [ + "UserContracts" + ], + "description": "Gets the Shared Access Authorization Token for the User.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "parameters", + "in": "body", + "description": "Create Authorization Token parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/UserTokenParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UserTokenResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUserToken": { + "$ref": "./examples/ApiManagementUserToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/validatePolicies": { + "post": { + "operationId": "PolicyRestrictionValidations_ByService", + "tags": [ + "ApiManagementServiceResources" + ], + "description": "Validate all policies of API Management services.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationResultContract" + } + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListPolicyRestrictions": { + "$ref": "./examples/ApiManagementValidatePolicies.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/OperationResultContract" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaceLinks": { + "get": { + "operationId": "ApiManagementWorkspaceLinks_ListByService", + "tags": [ + "ApiManagementWorkspaceLinksResources" + ], + "description": "List all API Management workspaceLinks for a service.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiManagementWorkspaceLinksListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListGatewayConfigConnection": { + "$ref": "./examples/ApiManagementListWorkspaceLinks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaceLinks/{workspaceId}": { + "get": { + "operationId": "ApiManagementWorkspaceLink_Get", + "tags": [ + "ApiManagementWorkspaceLinksResources" + ], + "description": "Gets an API Management WorkspaceLink resource description.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiManagementWorkspaceLinksResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceLinks": { + "$ref": "./examples/ApiManagementGetWorkspaceLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces": { + "get": { + "operationId": "Workspace_ListByService", + "tags": [ + "WorkspaceContracts" + ], + "description": "Lists all workspaces of the API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkspaceCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaces": { + "$ref": "./examples/ApiManagementListWorkspaces.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}": { + "get": { + "operationId": "Workspace_Get", + "tags": [ + "WorkspaceContracts" + ], + "description": "Gets the details of the workspace specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WorkspaceContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspace": { + "$ref": "./examples/ApiManagementGetWorkspace.json" + } + } + }, + "put": { + "operationId": "Workspace_CreateOrUpdate", + "tags": [ + "WorkspaceContracts" + ], + "description": "Creates a new workspace or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WorkspaceContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/WorkspaceContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspace": { + "$ref": "./examples/ApiManagementCreateWorkspace.json" + } + } + }, + "patch": { + "operationId": "Workspace_Update", + "tags": [ + "WorkspaceContracts" + ], + "description": "Updates the details of the workspace specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Workspace Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WorkspaceContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateWorkspace": { + "$ref": "./examples/ApiManagementUpdateWorkspace.json" + } + } + }, + "delete": { + "operationId": "Workspace_Delete", + "tags": [ + "WorkspaceContracts" + ], + "description": "Deletes the specified workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspace": { + "$ref": "./examples/ApiManagementDeleteWorkspace.json" + } + } + }, + "head": { + "operationId": "Workspace_GetEntityTag", + "tags": [ + "WorkspaceContracts" + ], + "description": "Gets the entity state (Etag) version of the workspace specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspace": { + "$ref": "./examples/ApiManagementHeadWorkspace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets": { + "get": { + "operationId": "WorkspaceApiVersionSet_ListByService", + "tags": [ + "WorkspaceApiVersionSet" + ], + "description": "Lists a collection of API Version Sets in the specified workspace with a service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiVersionSetCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceApiVersionSets": { + "$ref": "./examples/ApiManagementListWorkspaceApiVersionSets.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apiVersionSets/{versionSetId}": { + "get": { + "operationId": "WorkspaceApiVersionSet_Get", + "tags": [ + "WorkspaceApiVersionSet" + ], + "description": "Gets the details of the Api Version Set specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "versionSetId", + "in": "path", + "description": "Api Version Set identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceApiVersionSet": { + "$ref": "./examples/ApiManagementGetWorkspaceApiVersionSet.json" + } + } + }, + "put": { + "operationId": "WorkspaceApiVersionSet_CreateOrUpdate", + "tags": [ + "WorkspaceApiVersionSet" + ], + "description": "Creates or Updates a Api Version Set.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "versionSetId", + "in": "path", + "description": "Api Version Set identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiVersionSetContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceApiVersionSet": { + "$ref": "./examples/ApiManagementCreateWorkspaceApiVersionSet.json" + } + } + }, + "patch": { + "operationId": "WorkspaceApiVersionSet_Update", + "tags": [ + "WorkspaceApiVersionSet" + ], + "description": "Updates the details of the Api VersionSet specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "versionSetId", + "in": "path", + "description": "Api Version Set identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiVersionSetUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateWorkspaceApiVersionSet": { + "$ref": "./examples/ApiManagementUpdateWorkspaceApiVersionSet.json" + } + } + }, + "delete": { + "operationId": "WorkspaceApiVersionSet_Delete", + "tags": [ + "WorkspaceApiVersionSet" + ], + "description": "Deletes specific Api Version Set.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "versionSetId", + "in": "path", + "description": "Api Version Set identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceApiVersionSet": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApiVersionSet.json" + } + } + }, + "head": { + "operationId": "WorkspaceApiVersionSet_GetEntityTag", + "tags": [ + "WorkspaceApiVersionSet" + ], + "description": "Gets the entity state (Etag) version of the Api Version Set specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "versionSetId", + "in": "path", + "description": "Api Version Set identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceApiVersionSet": { + "$ref": "./examples/ApiManagementHeadWorkspaceApiVersionSet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis": { + "get": { + "operationId": "WorkspaceApi_ListByService", + "tags": [ + "WorkspaceApi" + ], + "description": "Lists all APIs of the workspace in an API Management service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-apis" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq, ne | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "tags", + "in": "query", + "description": "Include tags in the response.", + "required": false, + "type": "string" + }, + { + "name": "expandApiVersionSet", + "in": "query", + "description": "Include full ApiVersionSet resource in response", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceApis": { + "$ref": "./examples/ApiManagementListWorkspaceApis.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}": { + "get": { + "operationId": "WorkspaceApi_Get", + "tags": [ + "WorkspaceApi" + ], + "description": "Gets the details of the API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceApiContract": { + "$ref": "./examples/ApiManagementGetWorkspaceApiContract.json" + }, + "ApiManagementGetWorkspaceApiRevision": { + "$ref": "./examples/ApiManagementGetWorkspaceApiRevision.json" + } + } + }, + "put": { + "operationId": "WorkspaceApi_CreateOrUpdate", + "tags": [ + "WorkspaceApi" + ], + "description": "Creates new or updates existing specified API of the workspace in an API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiCreateOrUpdateParameter" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/ApiContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceApi": { + "$ref": "./examples/ApiManagementCreateWorkspaceApi.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/ApiContract" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "WorkspaceApi_Update", + "tags": [ + "WorkspaceApi" + ], + "description": "Updates the specified API of the workspace in an API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "API Update Contract parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateWorkspaceApi": { + "$ref": "./examples/ApiManagementUpdateWorkspaceApi.json" + } + } + }, + "delete": { + "operationId": "WorkspaceApi_Delete", + "tags": [ + "WorkspaceApi" + ], + "description": "Deletes the specified API of the workspace in an API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "deleteRevisions", + "in": "query", + "description": "Delete all revisions of the Api.", + "required": false, + "type": "boolean" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceApi": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApi.json" + } + } + }, + "head": { + "operationId": "WorkspaceApi_GetEntityTag", + "tags": [ + "WorkspaceApi" + ], + "description": "Gets the entity state (Etag) version of the API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceApi": { + "$ref": "./examples/ApiManagementHeadWorkspaceApi.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics": { + "get": { + "operationId": "WorkspaceApiDiagnostic_ListByWorkspace", + "tags": [ + "WorkspaceApiDiagnostic" + ], + "description": "Lists all diagnostics of an API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiagnosticCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceApiDiagnostics": { + "$ref": "./examples/ApiManagementListWorkspaceApiDiagnostics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId}": { + "get": { + "operationId": "WorkspaceApiDiagnostic_Get", + "tags": [ + "WorkspaceApiDiagnostic" + ], + "description": "Gets the details of the Diagnostic for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceApiDiagnostic": { + "$ref": "./examples/ApiManagementGetWorkspaceApiDiagnostic.json" + } + } + }, + "put": { + "operationId": "WorkspaceApiDiagnostic_CreateOrUpdate", + "tags": [ + "WorkspaceApiDiagnostic" + ], + "description": "Creates a new Diagnostic for an API or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceApiDiagnostic": { + "$ref": "./examples/ApiManagementCreateWorkspaceApiDiagnostic.json" + } + } + }, + "patch": { + "operationId": "WorkspaceApiDiagnostic_Update", + "tags": [ + "WorkspaceApiDiagnostic" + ], + "description": "Updates the details of the Diagnostic for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Diagnostic Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateWorkspaceApiDiagnostic": { + "$ref": "./examples/ApiManagementUpdateWorkspaceApiDiagnostic.json" + } + } + }, + "delete": { + "operationId": "WorkspaceApiDiagnostic_Delete", + "tags": [ + "WorkspaceApiDiagnostic" + ], + "description": "Deletes the specified Diagnostic from an API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceApiDiagnostic": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApiDiagnostic.json" + } + } + }, + "head": { + "operationId": "WorkspaceApiDiagnostic_GetEntityTag", + "tags": [ + "WorkspaceApiDiagnostic" + ], + "description": "Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceApiDiagnostic": { + "$ref": "./examples/ApiManagementHeadWorkspaceApiDiagnostic.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations": { + "get": { + "operationId": "WorkspaceApiOperation_ListByApi", + "tags": [ + "WorkspaceApiOperation" + ], + "description": "Lists a collection of the operations for the specified API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "tags", + "in": "query", + "description": "Include tags in the response.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceApiOperations": { + "$ref": "./examples/ApiManagementListWorkspaceApiOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}": { + "get": { + "operationId": "WorkspaceApiOperation_Get", + "tags": [ + "WorkspaceApiOperation" + ], + "description": "Gets the details of the API Operation specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceApiOperation": { + "$ref": "./examples/ApiManagementGetWorkspaceApiOperation.json" + } + } + }, + "put": { + "operationId": "WorkspaceApiOperation_CreateOrUpdate", + "tags": [ + "WorkspaceApiOperation" + ], + "description": "Creates a new operation in the API or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OperationContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceApiOperation": { + "$ref": "./examples/ApiManagementCreateWorkspaceApiOperation.json" + } + } + }, + "patch": { + "operationId": "WorkspaceApiOperation_Update", + "tags": [ + "WorkspaceApiOperation" + ], + "description": "Updates the details of the operation in the API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "API Operation Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OperationUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateWorkspaceApiOperation": { + "$ref": "./examples/ApiManagementUpdateWorkspaceApiOperation.json" + } + } + }, + "delete": { + "operationId": "WorkspaceApiOperation_Delete", + "tags": [ + "WorkspaceApiOperation" + ], + "description": "Deletes the specified operation in the API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceApiOperation": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApiOperation.json" + } + } + }, + "head": { + "operationId": "WorkspaceApiOperation_GetEntityTag", + "tags": [ + "WorkspaceApiOperation" + ], + "description": "Gets the entity state (Etag) version of the API operation specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceApiOperation": { + "$ref": "./examples/ApiManagementHeadWorkspaceApiOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}/policies": { + "get": { + "operationId": "WorkspaceApiOperationPolicy_ListByOperation", + "tags": [ + "WorkspaceApiOperationPolicy" + ], + "description": "Get the list of policy configuration at the API Operation level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PolicyCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceApiOperationPolicies": { + "$ref": "./examples/ApiManagementListWorkspaceApiOperationPolicies.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/operations/{operationId}/policies/{policyId}": { + "get": { + "operationId": "WorkspaceApiOperationPolicy_Get", + "tags": [ + "WorkspaceApiOperationPolicy" + ], + "description": "Get the policy configuration at the API Operation level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "format", + "in": "query", + "description": "Policy Export Format.", + "required": false, + "type": "string", + "default": "xml", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyExportFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceApiOperationPolicy": { + "$ref": "./examples/ApiManagementGetWorkspaceApiOperationPolicy.json" + } + } + }, + "put": { + "operationId": "WorkspaceApiOperationPolicy_CreateOrUpdate", + "tags": [ + "WorkspaceApiOperationPolicy" + ], + "description": "Creates or updates policy configuration for the API Operation level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The policy contents to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceApiOperationPolicy": { + "$ref": "./examples/ApiManagementCreateWorkspaceApiOperationPolicy.json" + } + } + }, + "delete": { + "operationId": "WorkspaceApiOperationPolicy_Delete", + "tags": [ + "WorkspaceApiOperationPolicy" + ], + "description": "Deletes the policy configuration at the Api Operation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceApiOperationPolicy": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApiOperationPolicy.json" + } + } + }, + "head": { + "operationId": "WorkspaceApiOperationPolicy_GetEntityTag", + "tags": [ + "WorkspaceApiOperationPolicy" + ], + "description": "Gets the entity state (Etag) version of the API operation policy specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceApiOperationPolicy": { + "$ref": "./examples/ApiManagementHeadWorkspaceApiOperationPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies": { + "get": { + "operationId": "WorkspaceApiPolicy_ListByApi", + "tags": [ + "WorkspaceApiPolicy" + ], + "description": "Get the policy configuration at the API level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PolicyCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceApiPolicies": { + "$ref": "./examples/ApiManagementListWorkspaceApiPolicies.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}": { + "get": { + "operationId": "WorkspaceApiPolicy_Get", + "tags": [ + "WorkspaceApiPolicy" + ], + "description": "Get the policy configuration at the API level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "format", + "in": "query", + "description": "Policy Export Format.", + "required": false, + "type": "string", + "default": "xml", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyExportFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceApiPolicy": { + "$ref": "./examples/ApiManagementGetWorkspaceApiPolicy.json" + } + } + }, + "put": { + "operationId": "WorkspaceApiPolicy_CreateOrUpdate", + "tags": [ + "WorkspaceApiPolicy" + ], + "description": "Creates or updates policy configuration for the API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The policy contents to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceApiPolicy": { + "$ref": "./examples/ApiManagementCreateWorkspaceApiPolicy.json" + } + } + }, + "delete": { + "operationId": "WorkspaceApiPolicy_Delete", + "tags": [ + "WorkspaceApiPolicy" + ], + "description": "Deletes the policy configuration at the Api.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceApiPolicy": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApiPolicy.json" + } + } + }, + "head": { + "operationId": "WorkspaceApiPolicy_GetEntityTag", + "tags": [ + "WorkspaceApiPolicy" + ], + "description": "Gets the entity state (Etag) version of the API policy specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceApiPolicy": { + "$ref": "./examples/ApiManagementHeadWorkspaceApiPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases": { + "get": { + "operationId": "WorkspaceApiRelease_ListByService", + "tags": [ + "WorkspaceApiRelease" + ], + "description": "Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| notes | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiReleaseCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceApiReleases": { + "$ref": "./examples/ApiManagementListWorkspaceApiReleases.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}": { + "get": { + "operationId": "WorkspaceApiRelease_Get", + "tags": [ + "WorkspaceApiRelease" + ], + "description": "Returns the details of an API release.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "releaseId", + "in": "path", + "description": "Release identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceApiRelease": { + "$ref": "./examples/ApiManagementGetWorkspaceApiRelease.json" + } + } + }, + "put": { + "operationId": "WorkspaceApiRelease_CreateOrUpdate", + "tags": [ + "WorkspaceApiRelease" + ], + "description": "Creates a new Release for the API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "releaseId", + "in": "path", + "description": "Release identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceApiRelease": { + "$ref": "./examples/ApiManagementCreateWorkspaceApiRelease.json" + } + } + }, + "patch": { + "operationId": "WorkspaceApiRelease_Update", + "tags": [ + "WorkspaceApiRelease" + ], + "description": "Updates the details of the release of the API specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "releaseId", + "in": "path", + "description": "Release identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "API Release Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateWorkspaceApiRelease": { + "$ref": "./examples/ApiManagementUpdateWorkspaceApiRelease.json" + } + } + }, + "delete": { + "operationId": "WorkspaceApiRelease_Delete", + "tags": [ + "WorkspaceApiRelease" + ], + "description": "Deletes the specified release in the API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "releaseId", + "in": "path", + "description": "Release identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceApiRelease": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApiRelease.json" + } + } + }, + "head": { + "operationId": "WorkspaceApiRelease_GetEntityTag", + "tags": [ + "WorkspaceApiRelease" + ], + "description": "Returns the etag of an API release.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "releaseId", + "in": "path", + "description": "Release identifier within an API. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceApiRelease": { + "$ref": "./examples/ApiManagementHeadWorkspaceApiRelease.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/revisions": { + "get": { + "operationId": "WorkspaceApiRevision_ListByService", + "tags": [ + "WorkspaceApi" + ], + "description": "Lists all revisions of an API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiRevisionCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceApiRevisions": { + "$ref": "./examples/ApiManagementListWorkspaceApiRevisions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas": { + "get": { + "operationId": "WorkspaceApiSchema_ListByApi", + "tags": [ + "WorkspaceApiSchema" + ], + "description": "Get the schema configuration at the API level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SchemaCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceApiSchemas": { + "$ref": "./examples/ApiManagementListWorkspaceApiSchemas.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas/{schemaId}": { + "get": { + "operationId": "WorkspaceApiSchema_Get", + "tags": [ + "WorkspaceApiSchema" + ], + "description": "Get the schema configuration at the API level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SchemaContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceApiSchema": { + "$ref": "./examples/ApiManagementGetWorkspaceApiSchema.json" + } + } + }, + "put": { + "operationId": "WorkspaceApiSchema_CreateOrUpdate", + "tags": [ + "WorkspaceApiSchema" + ], + "description": "Creates or updates schema configuration for the API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The schema contents to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/SchemaContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SchemaContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/SchemaContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceApiSchema": { + "$ref": "./examples/ApiManagementCreateWorkspaceApiSchema.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/SchemaContract" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "WorkspaceApiSchema_Delete", + "tags": [ + "WorkspaceApiSchema" + ], + "description": "Deletes the schema configuration at the Api.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "force", + "in": "query", + "description": "If true removes all references to the schema before deleting it.", + "required": false, + "type": "boolean" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceApiSchema": { + "$ref": "./examples/ApiManagementDeleteWorkspaceApiSchema.json" + } + } + }, + "head": { + "operationId": "WorkspaceApiSchema_GetEntityTag", + "tags": [ + "WorkspaceApiSchema" + ], + "description": "Gets the entity state (Etag) version of the schema specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceApiSchema": { + "$ref": "./examples/ApiManagementHeadWorkspaceApiSchema.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/backends": { + "get": { + "operationId": "WorkspaceBackend_ListByWorkspace", + "tags": [ + "WorkspaceBackend" + ], + "description": "Lists a collection of backends in the specified workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BackendCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceBackends": { + "$ref": "./examples/ApiManagementListWorkspaceBackends.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/backends/{backendId}": { + "get": { + "operationId": "WorkspaceBackend_Get", + "tags": [ + "WorkspaceBackend" + ], + "description": "Gets the details of the backend specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "backendId", + "in": "path", + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BackendContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceBackend": { + "$ref": "./examples/ApiManagementGetWorkspaceBackend.json" + } + } + }, + "put": { + "operationId": "WorkspaceBackend_CreateOrUpdate", + "tags": [ + "WorkspaceBackend" + ], + "description": "Creates or Updates a backend.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "backendId", + "in": "path", + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BackendContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BackendContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/BackendContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceBackendProxyBackend": { + "$ref": "./examples/ApiManagementCreateWorkspaceBackendProxyBackend.json" + }, + "ApiManagementCreateWorkspaceBackendServiceFabric": { + "$ref": "./examples/ApiManagementCreateWorkspaceBackendServiceFabric.json" + } + } + }, + "patch": { + "operationId": "WorkspaceBackend_Update", + "tags": [ + "WorkspaceBackend" + ], + "description": "Updates an existing backend.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "backendId", + "in": "path", + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BackendUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BackendContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateWorkspaceBackend": { + "$ref": "./examples/ApiManagementUpdateWorkspaceBackend.json" + } + } + }, + "delete": { + "operationId": "WorkspaceBackend_Delete", + "tags": [ + "WorkspaceBackend" + ], + "description": "Deletes the specified backend.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "backendId", + "in": "path", + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceBackend": { + "$ref": "./examples/ApiManagementDeleteWorkspaceBackend.json" + } + } + }, + "head": { + "operationId": "WorkspaceBackend_GetEntityTag", + "tags": [ + "WorkspaceBackend" + ], + "description": "Gets the entity state (Etag) version of the backend specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "backendId", + "in": "path", + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceBackend": { + "$ref": "./examples/ApiManagementHeadWorkspaceBackend.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates": { + "get": { + "operationId": "WorkspaceCertificate_ListByWorkspace", + "tags": [ + "WorkspaceCertificate" + ], + "description": "Lists a collection of all certificates in the specified workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| expirationDate | filter | ge, le, eq, ne, gt, lt | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "isKeyVaultRefreshFailed", + "in": "query", + "description": "When set to true, the response contains only certificates entities which failed refresh.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceCertificates": { + "$ref": "./examples/ApiManagementListWorkspaceCertificates.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates/{certificateId}": { + "get": { + "operationId": "WorkspaceCertificate_Get", + "tags": [ + "WorkspaceCertificate" + ], + "description": "Gets the details of the certificate specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "certificateId", + "in": "path", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CertificateContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceCertificate": { + "$ref": "./examples/ApiManagementGetWorkspaceCertificate.json" + }, + "ApiManagementGetWorkspaceCertificateWithKeyVault": { + "$ref": "./examples/ApiManagementGetWorkspaceCertificateWithKeyVault.json" + } + } + }, + "put": { + "operationId": "WorkspaceCertificate_CreateOrUpdate", + "tags": [ + "WorkspaceCertificate" + ], + "description": "Creates or updates the certificate being used for authentication with the backend.", + "externalDocs": { + "description": "How to secure back-end services using client certificate authentication in Azure API Management", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "certificateId", + "in": "path", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateCreateOrUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CertificateContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/CertificateContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceCertificate": { + "$ref": "./examples/ApiManagementCreateWorkspaceCertificate.json" + }, + "ApiManagementCreateWorkspaceCertificateWithKeyVault": { + "$ref": "./examples/ApiManagementCreateWorkspaceCertificateWithKeyVault.json" + } + } + }, + "delete": { + "operationId": "WorkspaceCertificate_Delete", + "tags": [ + "WorkspaceCertificate" + ], + "description": "Deletes specific certificate.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "certificateId", + "in": "path", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceCertificate": { + "$ref": "./examples/ApiManagementDeleteWorkspaceCertificate.json" + } + } + }, + "head": { + "operationId": "WorkspaceCertificate_GetEntityTag", + "tags": [ + "WorkspaceCertificate" + ], + "description": "Gets the entity state (Etag) version of the certificate specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "certificateId", + "in": "path", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementWorkspaceHeadCertificate": { + "$ref": "./examples/ApiManagementHeadWorkspaceCertificate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/certificates/{certificateId}/refreshSecret": { + "post": { + "operationId": "WorkspaceCertificate_RefreshSecret", + "tags": [ + "WorkspaceCertificate" + ], + "description": "From KeyVault, Refresh the certificate being used for authentication with the backend.", + "externalDocs": { + "description": "How to secure back-end services using client certificate authentication in Azure API Management", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "certificateId", + "in": "path", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementRefreshWorkspaceCertificate": { + "$ref": "./examples/ApiManagementRefreshWorkspaceCertificate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/diagnostics": { + "get": { + "operationId": "WorkspaceDiagnostic_ListByWorkspace", + "tags": [ + "WorkspaceDiagnostic" + ], + "description": "Lists all diagnostics in the specified workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiagnosticCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceDiagnostics": { + "$ref": "./examples/ApiManagementListWorkspaceDiagnostics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/diagnostics/{diagnosticId}": { + "get": { + "operationId": "WorkspaceDiagnostic_Get", + "tags": [ + "WorkspaceDiagnostic" + ], + "description": "Gets the details of the Diagnostic specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceDiagnostic": { + "$ref": "./examples/ApiManagementGetWorkspaceDiagnostic.json" + } + } + }, + "put": { + "operationId": "WorkspaceDiagnostic_CreateOrUpdate", + "tags": [ + "WorkspaceDiagnostic" + ], + "description": "Creates a new Diagnostic or updates an existing one.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceDiagnostic": { + "$ref": "./examples/ApiManagementCreateWorkspaceDiagnostic.json" + } + } + }, + "patch": { + "operationId": "WorkspaceDiagnostic_Update", + "tags": [ + "WorkspaceDiagnostic" + ], + "description": "Updates the details of the Diagnostic specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Diagnostic Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateWorkspaceDiagnostic": { + "$ref": "./examples/ApiManagementUpdateWorkspaceDiagnostic.json" + } + } + }, + "delete": { + "operationId": "WorkspaceDiagnostic_Delete", + "tags": [ + "WorkspaceDiagnostic" + ], + "description": "Deletes the specified Diagnostic.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceDiagnostic": { + "$ref": "./examples/ApiManagementDeleteWorkspaceDiagnostic.json" + } + } + }, + "head": { + "operationId": "WorkspaceDiagnostic_GetEntityTag", + "tags": [ + "WorkspaceDiagnostic" + ], + "description": "Gets the entity state (Etag) version of the Diagnostic specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "diagnosticId", + "in": "path", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceDiagnostic": { + "$ref": "./examples/ApiManagementHeadWorkspaceDiagnostic.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups": { + "get": { + "operationId": "WorkspaceGroup_ListByService", + "tags": [ + "WorkspaceGroup" + ], + "description": "Lists a collection of groups defined within a workspace in a service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-groups" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| externalId | filter | eq | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GroupCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceGroups": { + "$ref": "./examples/ApiManagementListWorkspaceGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}": { + "get": { + "operationId": "WorkspaceGroup_Get", + "tags": [ + "WorkspaceGroup" + ], + "description": "Gets the details of the group specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceGroup": { + "$ref": "./examples/ApiManagementGetWorkspaceGroup.json" + } + } + }, + "put": { + "operationId": "WorkspaceGroup_CreateOrUpdate", + "tags": [ + "WorkspaceGroup" + ], + "description": "Creates or Updates 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": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GroupCreateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceGroup": { + "$ref": "./examples/ApiManagementCreateWorkspaceGroup.json" + }, + "ApiManagementCreateWorkspaceGroupExternal": { + "$ref": "./examples/ApiManagementCreateWorkspaceGroupExternal.json" + } + } + }, + "patch": { + "operationId": "WorkspaceGroup_Update", + "tags": [ + "WorkspaceGroup" + ], + "description": "Updates the details of the group specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GroupUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateWorkspaceGroup": { + "$ref": "./examples/ApiManagementUpdateWorkspaceGroup.json" + } + } + }, + "delete": { + "operationId": "WorkspaceGroup_Delete", + "tags": [ + "WorkspaceGroup" + ], + "description": "Deletes specific group of the workspace in an API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceGroup": { + "$ref": "./examples/ApiManagementDeleteWorkspaceGroup.json" + } + } + }, + "head": { + "operationId": "WorkspaceGroup_GetEntityTag", + "tags": [ + "WorkspaceGroup" + ], + "description": "Gets the entity state (Etag) version of the group specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceGroup": { + "$ref": "./examples/ApiManagementHeadWorkspaceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users": { + "get": { + "operationId": "WorkspaceGroupUser_List", + "tags": [ + "WorkspaceGroup" + ], + "description": "Lists a collection of user entities associated with the 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": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UserCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceGroupUsers": { + "$ref": "./examples/ApiManagementListWorkspaceGroupUsers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/groups/{groupId}/users/{userId}": { + "put": { + "operationId": "WorkspaceGroupUser_Create", + "tags": [ + "WorkspaceGroup" + ], + "description": "Add existing user to existing 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": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UserContract" + } + }, + "201": { + "description": "Resource 'UserContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/UserContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceGroupUser": { + "$ref": "./examples/ApiManagementCreateWorkspaceGroupUser.json" + } + } + }, + "delete": { + "operationId": "WorkspaceGroupUser_Delete", + "tags": [ + "WorkspaceGroup" + ], + "description": "Remove existing user from existing 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": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementDeleteWorkspaceGroupUser": { + "$ref": "./examples/ApiManagementDeleteWorkspaceGroupUser.json" + } + } + }, + "head": { + "operationId": "WorkspaceGroupUser_CheckEntityExists", + "tags": [ + "WorkspaceGroup" + ], + "description": "Checks that user entity specified by identifier is associated with the group entity.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "groupId", + "in": "path", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "404": { + "description": "The server cannot find the requested resource." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceGroupUser": { + "$ref": "./examples/ApiManagementHeadWorkspaceGroupUser.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/loggers": { + "get": { + "operationId": "WorkspaceLogger_ListByWorkspace", + "tags": [ + "WorkspaceLogger" + ], + "description": "Lists a collection of loggers in the specified workspace.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-log-event-hubs" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| loggerType | filter | eq | |
| resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LoggerCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceLoggers": { + "$ref": "./examples/ApiManagementListWorkspaceLoggers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/loggers/{loggerId}": { + "get": { + "operationId": "WorkspaceLogger_Get", + "tags": [ + "WorkspaceLogger" + ], + "description": "Gets the details of the logger specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "loggerId", + "in": "path", + "description": "Logger identifier. Must be unique in the API Management service instance.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceLogger": { + "$ref": "./examples/ApiManagementGetWorkspaceLogger.json" + } + } + }, + "put": { + "operationId": "WorkspaceLogger_CreateOrUpdate", + "tags": [ + "WorkspaceLogger" + ], + "description": "Creates or Updates a logger.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "loggerId", + "in": "path", + "description": "Logger identifier. Must be unique in the API Management service instance.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LoggerContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceAILogger": { + "$ref": "./examples/ApiManagementCreateWorkspaceAILogger.json" + }, + "ApiManagementCreateWorkspaceEHLogger": { + "$ref": "./examples/ApiManagementCreateWorkspaceEHLogger.json" + } + } + }, + "patch": { + "operationId": "WorkspaceLogger_Update", + "tags": [ + "WorkspaceLogger" + ], + "description": "Updates an existing logger.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "loggerId", + "in": "path", + "description": "Logger identifier. Must be unique in the API Management service instance.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LoggerUpdateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateWorkspaceLogger": { + "$ref": "./examples/ApiManagementUpdateWorkspaceLogger.json" + } + } + }, + "delete": { + "operationId": "WorkspaceLogger_Delete", + "tags": [ + "WorkspaceLogger" + ], + "description": "Deletes the specified logger.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "loggerId", + "in": "path", + "description": "Logger identifier. Must be unique in the API Management service instance.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceLogger": { + "$ref": "./examples/ApiManagementDeleteWorkspaceLogger.json" + } + } + }, + "head": { + "operationId": "WorkspaceLogger_GetEntityTag", + "tags": [ + "WorkspaceLogger" + ], + "description": "Gets the entity state (Etag) version of the logger specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "loggerId", + "in": "path", + "description": "Logger identifier. Must be unique in the API Management service instance.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceLogger": { + "$ref": "./examples/ApiManagementHeadWorkspaceLogger.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues": { + "get": { + "operationId": "WorkspaceNamedValue_ListByService", + "tags": [ + "WorkspaceNamedValue" + ], + "description": "Lists a collection of named values defined within a workspace in a service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "isKeyVaultRefreshFailed", + "in": "query", + "description": "Query parameter to fetch named value entities based on refresh status.", + "required": false, + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "KeyVaultRefreshState", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Entities for which KeyVault refresh failed." + }, + { + "name": "false", + "value": "false", + "description": "Entities for which KeyVault refresh succeeded" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NamedValueCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceNamedValues": { + "$ref": "./examples/ApiManagementListWorkspaceNamedValues.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}": { + "get": { + "operationId": "WorkspaceNamedValue_Get", + "tags": [ + "WorkspaceNamedValue" + ], + "description": "Gets the details of the named value specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "namedValueId", + "in": "path", + "description": "Identifier of the NamedValue.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceNamedValue": { + "$ref": "./examples/ApiManagementGetWorkspaceNamedValue.json" + }, + "ApiManagementGetWorkspaceNamedValueWithKeyVault": { + "$ref": "./examples/ApiManagementGetWorkspaceNamedValueWithKeyVault.json" + } + } + }, + "put": { + "operationId": "WorkspaceNamedValue_CreateOrUpdate", + "tags": [ + "WorkspaceNamedValue" + ], + "description": "Creates or updates named value.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "namedValueId", + "in": "path", + "description": "Identifier of the NamedValue.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NamedValueCreateContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/NamedValueContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/NamedValueContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "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": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceNamedValue": { + "$ref": "./examples/ApiManagementCreateWorkspaceNamedValue.json" + }, + "ApiManagementCreateWorkspaceNamedValueWithKeyVault": { + "$ref": "./examples/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/NamedValueContract" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "WorkspaceNamedValue_Update", + "tags": [ + "WorkspaceNamedValue" + ], + "description": "Updates the specific named value.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "namedValueId", + "in": "path", + "description": "Identifier of the NamedValue.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NamedValueUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateWorkspaceNamedValue": { + "$ref": "./examples/ApiManagementUpdateWorkspaceNamedValue.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/NamedValueContract" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "WorkspaceNamedValue_Delete", + "tags": [ + "WorkspaceNamedValue" + ], + "description": "Deletes specific named value from the workspace in an API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "namedValueId", + "in": "path", + "description": "Identifier of the NamedValue.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceNamedValue": { + "$ref": "./examples/ApiManagementDeleteWorkspaceNamedValue.json" + } + } + }, + "head": { + "operationId": "WorkspaceNamedValue_GetEntityTag", + "tags": [ + "WorkspaceNamedValue" + ], + "description": "Gets the entity state (Etag) version of the named value specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "namedValueId", + "in": "path", + "description": "Identifier of the NamedValue.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceNamedValue": { + "$ref": "./examples/ApiManagementHeadWorkspaceNamedValue.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}/listValue": { + "post": { + "operationId": "WorkspaceNamedValue_ListValue", + "tags": [ + "WorkspaceNamedValue" + ], + "description": "Gets the secret of the named value specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "namedValueId", + "in": "path", + "description": "Identifier of the NamedValue.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NamedValueSecretContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementWorkspaceNamedValueListValue": { + "$ref": "./examples/ApiManagementWorkspaceNamedValueListValue.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}/refreshSecret": { + "post": { + "operationId": "WorkspaceNamedValue_RefreshSecret", + "tags": [ + "WorkspaceNamedValue" + ], + "description": "Refresh the secret of the named value specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "namedValueId", + "in": "path", + "description": "Identifier of the NamedValue.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NamedValueContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementRefreshWorkspaceNamedValue": { + "$ref": "./examples/ApiManagementRefreshWorkspaceNamedValue.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/NamedValueContract" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications": { + "get": { + "operationId": "WorkspaceNotification_ListByService", + "tags": [ + "WorkspaceNotification" + ], + "description": "Lists a collection of properties defined within a service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NotificationCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceNotifications": { + "$ref": "./examples/ApiManagementListWorkspaceNotifications.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}": { + "get": { + "operationId": "WorkspaceNotification_Get", + "tags": [ + "WorkspaceNotification" + ], + "description": "Gets the details of the Notification specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NotificationContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceNotification": { + "$ref": "./examples/ApiManagementGetWorkspaceNotification.json" + } + } + }, + "put": { + "operationId": "WorkspaceNotification_CreateOrUpdate", + "tags": [ + "WorkspaceNotification" + ], + "description": "Create or Update API Management publisher notification for the workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource 'NotificationContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/NotificationContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceNotification": { + "$ref": "./examples/ApiManagementCreateWorkspaceNotification.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientEmails": { + "get": { + "operationId": "WorkspaceNotificationRecipientEmail_ListByNotification", + "tags": [ + "WorkspaceNotification" + ], + "description": "Gets the list of the Notification Recipient Emails subscribed to a notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RecipientEmailCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceNotificationRecipientEmails": { + "$ref": "./examples/ApiManagementListWorkspaceNotificationRecipientEmails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientEmails/{email}": { + "put": { + "operationId": "WorkspaceNotificationRecipientEmail_CreateOrUpdate", + "tags": [ + "WorkspaceNotification" + ], + "description": "Adds the Email address to the list of Recipients for the Notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + { + "name": "email", + "in": "path", + "description": "Email identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RecipientEmailContract" + } + }, + "201": { + "description": "Resource 'RecipientEmailContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/RecipientEmailContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementCreateWorkspaceNotificationRecipientEmail.json" + } + } + }, + "delete": { + "operationId": "WorkspaceNotificationRecipientEmail_Delete", + "tags": [ + "WorkspaceNotification" + ], + "description": "Removes the email from the list of Notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + { + "name": "email", + "in": "path", + "description": "Email identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementDeleteWorkspaceNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementDeleteWorkspaceNotificationRecipientEmail.json" + } + } + }, + "head": { + "operationId": "WorkspaceNotificationRecipientEmail_CheckEntityExists", + "tags": [ + "WorkspaceNotification" + ], + "description": "Determine if Notification Recipient Email subscribed to the notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + { + "name": "email", + "in": "path", + "description": "Email identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "404": { + "description": "The server cannot find the requested resource." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementHeadWorkspaceNotificationRecipientEmail.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientUsers": { + "get": { + "operationId": "WorkspaceNotificationRecipientUser_ListByNotification", + "tags": [ + "WorkspaceNotification" + ], + "description": "Gets the list of the Notification Recipient User subscribed to the notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RecipientUserCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceNotificationRecipientUsers": { + "$ref": "./examples/ApiManagementListWorkspaceNotificationRecipientUsers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientUsers/{userId}": { + "put": { + "operationId": "WorkspaceNotificationRecipientUser_CreateOrUpdate", + "tags": [ + "WorkspaceNotification" + ], + "description": "Adds the API Management User to the list of Recipients for the Notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Notification Name Identifier.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RecipientUserContract" + } + }, + "201": { + "description": "Resource 'RecipientUserContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/RecipientUserContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceNotificationRecipientUser": { + "$ref": "./examples/ApiManagementCreateWorkspaceNotificationRecipientUser.json" + } + } + }, + "delete": { + "operationId": "WorkspaceNotificationRecipientUser_Delete", + "tags": [ + "WorkspaceNotification" + ], + "description": "Removes the API Management user from the list of Notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementDeleteWorkspaceNotificationRecipientUser": { + "$ref": "./examples/ApiManagementDeleteWorkspaceNotificationRecipientUser.json" + } + } + }, + "head": { + "operationId": "WorkspaceNotificationRecipientUser_CheckEntityExists", + "tags": [ + "WorkspaceNotification" + ], + "description": "Determine if the Notification Recipient User is subscribed to the notification.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "notificationName", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + { + "name": "userId", + "in": "path", + "description": "User identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "404": { + "description": "The server cannot find the requested resource." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceNotificationRecipientUser": { + "$ref": "./examples/ApiManagementHeadWorkspaceNotificationRecipientUser.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies": { + "get": { + "operationId": "WorkspacePolicy_ListByApi", + "tags": [ + "WorkspacePolicy" + ], + "description": "Get the policy configuration at the workspace level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PolicyCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspacePolicies": { + "$ref": "./examples/ApiManagementListWorkspacePolicies.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies/{policyId}": { + "get": { + "operationId": "WorkspacePolicy_Get", + "tags": [ + "WorkspacePolicy" + ], + "description": "Get the policy configuration at the API level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "format", + "in": "query", + "description": "Policy Export Format.", + "required": false, + "type": "string", + "default": "xml", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyExportFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspacePolicy": { + "$ref": "./examples/ApiManagementGetWorkspacePolicy.json" + } + } + }, + "put": { + "operationId": "WorkspacePolicy_CreateOrUpdate", + "tags": [ + "WorkspacePolicy" + ], + "description": "Creates or updates policy configuration for the workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The policy contents to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspacePolicy": { + "$ref": "./examples/ApiManagementCreateWorkspacePolicy.json" + }, + "ApiManagementCreateWorkspacePolicyNonXmlEncoded": { + "$ref": "./examples/ApiManagementCreateWorkspacePolicyNonXmlEncoded.json" + } + } + }, + "delete": { + "operationId": "WorkspacePolicy_Delete", + "tags": [ + "WorkspacePolicy" + ], + "description": "Deletes the policy configuration at the workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspacePolicy": { + "$ref": "./examples/ApiManagementDeleteWorkspacePolicy.json" + } + } + }, + "head": { + "operationId": "WorkspacePolicy_GetEntityTag", + "tags": [ + "WorkspacePolicy" + ], + "description": "Gets the entity state (Etag) version of the workspace policy specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspacePolicy": { + "$ref": "./examples/ApiManagementHeadWorkspacePolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments": { + "get": { + "operationId": "WorkspacePolicyFragment_ListByService", + "tags": [ + "WorkspacePolicyFragment" + ], + "description": "Gets all policy fragments defined within a workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter, orderBy | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| value | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$orderby", + "in": "query", + "description": "OData order by query option.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PolicyFragmentCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspacePolicyFragments": { + "$ref": "./examples/ApiManagementListWorkspacePolicyFragments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}": { + "get": { + "operationId": "WorkspacePolicyFragment_Get", + "tags": [ + "WorkspacePolicyFragment" + ], + "description": "Gets a policy fragment.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "id", + "in": "path", + "description": "A resource identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)" + }, + { + "name": "format", + "in": "query", + "description": "Policy fragment content format.", + "required": false, + "type": "string", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyFragmentContentFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyFragmentContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspacePolicyFragment": { + "$ref": "./examples/ApiManagementGetWorkspacePolicyFragment.json" + }, + "ApiManagementGetWorkspacePolicyFragmentFormat": { + "$ref": "./examples/ApiManagementGetWorkspacePolicyFragmentFormat.json" + } + } + }, + "put": { + "operationId": "WorkspacePolicyFragment_CreateOrUpdate", + "tags": [ + "WorkspacePolicyFragment" + ], + "description": "Creates or updates a policy fragment.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "id", + "in": "path", + "description": "A resource identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The policy fragment contents to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyFragmentContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyFragmentContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version" + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/PolicyFragmentContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspacePolicyFragment": { + "$ref": "./examples/ApiManagementCreateWorkspacePolicyFragment.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/PolicyFragmentContract" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "WorkspacePolicyFragment_Delete", + "tags": [ + "WorkspacePolicyFragment" + ], + "description": "Deletes a policy fragment.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "id", + "in": "path", + "description": "A resource identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspacePolicyFragment": { + "$ref": "./examples/ApiManagementDeleteWorkspacePolicyFragment.json" + } + } + }, + "head": { + "operationId": "WorkspacePolicyFragment_GetEntityTag", + "tags": [ + "WorkspacePolicyFragment" + ], + "description": "Gets the entity state (Etag) version of a policy fragment.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "id", + "in": "path", + "description": "A resource identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspacePolicyFragment": { + "$ref": "./examples/ApiManagementHeadWorkspacePolicyFragment.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policyFragments/{id}/listReferences": { + "post": { + "operationId": "WorkspacePolicyFragment_ListReferences", + "tags": [ + "WorkspacePolicyFragment" + ], + "description": "Lists policy resources that reference the policy fragment.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "id", + "in": "path", + "description": "A resource identifier.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ResourceCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspacePolicyFragmentReferences": { + "$ref": "./examples/ApiManagementListWorkspacePolicyFragmentReferences.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products": { + "get": { + "operationId": "WorkspaceProduct_ListByService", + "tags": [ + "WorkspaceProduct" + ], + "description": "Lists a collection of products in the specified workspace in a service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| groups | expand | | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "expandGroups", + "in": "query", + "description": "When set to true, the response contains an array of groups that have visibility to the product. The default is false.", + "required": false, + "type": "boolean" + }, + { + "name": "tags", + "in": "query", + "description": "Products which are part of a specific tag.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProductCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceProducts": { + "$ref": "./examples/ApiManagementListWorkspaceProducts.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}": { + "get": { + "operationId": "WorkspaceProduct_Get", + "tags": [ + "WorkspaceProduct" + ], + "description": "Gets the details of the product specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceProduct": { + "$ref": "./examples/ApiManagementGetWorkspaceProduct.json" + } + } + }, + "put": { + "operationId": "WorkspaceProduct_CreateOrUpdate", + "tags": [ + "WorkspaceProduct" + ], + "description": "Creates or Updates a product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ProductContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceProduct": { + "$ref": "./examples/ApiManagementCreateWorkspaceProduct.json" + } + } + }, + "patch": { + "operationId": "WorkspaceProduct_Update", + "tags": [ + "WorkspaceProduct" + ], + "description": "Update existing product details.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ProductUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateWorkspaceProduct": { + "$ref": "./examples/ApiManagementUpdateWorkspaceProduct.json" + } + } + }, + "delete": { + "operationId": "WorkspaceProduct_Delete", + "tags": [ + "WorkspaceProduct" + ], + "description": "Delete product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "deleteSubscriptions", + "in": "query", + "description": "Delete existing subscriptions associated with the product or not.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceProduct": { + "$ref": "./examples/ApiManagementDeleteWorkspaceProduct.json" + } + } + }, + "head": { + "operationId": "WorkspaceProduct_GetEntityTag", + "tags": [ + "WorkspaceProduct" + ], + "description": "Gets the entity state (Etag) version of the product specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceProduct": { + "$ref": "./examples/ApiManagementHeadWorkspaceProduct.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/apiLinks": { + "get": { + "operationId": "WorkspaceProductApiLink_ListByProduct", + "tags": [ + "WorkspaceProductApiLink" + ], + "description": "Lists a collection of the API links associated with a product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProductApiLinkCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceProductApiLinks": { + "$ref": "./examples/ApiManagementListWorkspaceProductApiLinks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/apiLinks/{apiLinkId}": { + "get": { + "operationId": "WorkspaceProductApiLink_Get", + "tags": [ + "WorkspaceProductApiLink" + ], + "description": "Gets the API link for the product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "apiLinkId", + "in": "path", + "description": "Product-API link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductApiLinkContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceProductApiLink": { + "$ref": "./examples/ApiManagementGetWorkspaceProductApiLink.json" + } + } + }, + "put": { + "operationId": "WorkspaceProductApiLink_CreateOrUpdate", + "tags": [ + "WorkspaceProductApiLink" + ], + "description": "Adds an API to the specified product via link.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "apiLinkId", + "in": "path", + "description": "Product-API link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ProductApiLinkContract" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ProductApiLinkContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/ProductApiLinkContract" + } + }, + "201": { + "description": "Resource 'ProductApiLinkContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/ProductApiLinkContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceProductApiLink": { + "$ref": "./examples/ApiManagementCreateWorkspaceProductApiLink.json" + } + } + }, + "delete": { + "operationId": "WorkspaceProductApiLink_Delete", + "tags": [ + "WorkspaceProductApiLink" + ], + "description": "Deletes the specified API from the specified product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "apiLinkId", + "in": "path", + "description": "Product-API link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceProductApiLink": { + "$ref": "./examples/ApiManagementDeleteWorkspaceProductApiLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/groupLinks": { + "get": { + "operationId": "WorkspaceProductGroupLink_ListByProduct", + "tags": [ + "WorkspaceProductGroupLink" + ], + "description": "Lists a collection of the group links associated with a product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| groupId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProductGroupLinkCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceProductGroupLinks": { + "$ref": "./examples/ApiManagementListWorkspaceProductGroupLinks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/groupLinks/{groupLinkId}": { + "get": { + "operationId": "WorkspaceProductGroupLink_Get", + "tags": [ + "WorkspaceProductGroupLink" + ], + "description": "Gets the group link for the product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "groupLinkId", + "in": "path", + "description": "Product-Group link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductGroupLinkContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceProductGroupLink": { + "$ref": "./examples/ApiManagementGetWorkspaceProductGroupLink.json" + } + } + }, + "put": { + "operationId": "WorkspaceProductGroupLink_CreateOrUpdate", + "tags": [ + "WorkspaceProductGroupLink" + ], + "description": "Adds a group to the specified product via link.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "groupLinkId", + "in": "path", + "description": "Product-Group link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ProductGroupLinkContract" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ProductGroupLinkContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/ProductGroupLinkContract" + } + }, + "201": { + "description": "Resource 'ProductGroupLinkContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/ProductGroupLinkContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceProductGroupLink": { + "$ref": "./examples/ApiManagementCreateWorkspaceProductGroupLink.json" + } + } + }, + "delete": { + "operationId": "WorkspaceProductGroupLink_Delete", + "tags": [ + "WorkspaceProductGroupLink" + ], + "description": "Deletes the specified group from the specified product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "groupLinkId", + "in": "path", + "description": "Product-Group link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceProductGroupLink": { + "$ref": "./examples/ApiManagementDeleteWorkspaceProductGroupLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/policies": { + "get": { + "operationId": "WorkspaceProductPolicy_ListByProduct", + "tags": [ + "WorkspaceProductPolicy" + ], + "description": "Get the policy configuration at the Product level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PolicyCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceProductPolicies": { + "$ref": "./examples/ApiManagementListWorkspaceProductPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/policies/{policyId}": { + "get": { + "operationId": "WorkspaceProductPolicy_Get", + "tags": [ + "WorkspaceProductPolicy" + ], + "description": "Get the policy configuration at the Product level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "format", + "in": "query", + "description": "Policy Export Format.", + "required": false, + "type": "string", + "default": "xml", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyExportFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceProductPolicy": { + "$ref": "./examples/ApiManagementGetWorkspaceProductPolicy.json" + } + } + }, + "put": { + "operationId": "WorkspaceProductPolicy_CreateOrUpdate", + "tags": [ + "WorkspaceProductPolicy" + ], + "description": "Creates or updates policy configuration for the Product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The policy contents to apply.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceProductPolicy": { + "$ref": "./examples/ApiManagementCreateWorkspaceProductPolicy.json" + } + } + }, + "delete": { + "operationId": "WorkspaceProductPolicy_Delete", + "tags": [ + "WorkspaceProductPolicy" + ], + "description": "Deletes the policy configuration at the Product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceProductPolicy": { + "$ref": "./examples/ApiManagementDeleteWorkspaceProductPolicy.json" + } + } + }, + "head": { + "operationId": "WorkspaceProductPolicy_GetEntityTag", + "tags": [ + "WorkspaceProductPolicy" + ], + "description": "Get the ETag of the policy configuration at the Product level.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productId", + "in": "path", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256 + }, + { + "name": "policyId", + "in": "path", + "description": "The identifier of the Policy.", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceProductPolicy": { + "$ref": "./examples/ApiManagementHeadWorkspaceProductPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas": { + "get": { + "operationId": "WorkspaceGlobalSchema_ListByService", + "tags": [ + "WorkspaceGlobalSchema" + ], + "description": "Lists a collection of schemas registered with workspace in a service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GlobalSchemaCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceSchemas": { + "$ref": "./examples/ApiManagementListWorkspaceSchemas.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/schemas/{schemaId}": { + "get": { + "operationId": "WorkspaceGlobalSchema_Get", + "tags": [ + "WorkspaceGlobalSchema" + ], + "description": "Gets the details of the Schema specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GlobalSchemaContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceSchema": { + "$ref": "./examples/ApiManagementGetWorkspaceSchema.json" + } + } + }, + "put": { + "operationId": "WorkspaceGlobalSchema_CreateOrUpdate", + "tags": [ + "WorkspaceGlobalSchema" + ], + "description": "Creates new or updates existing specified Schema of the workspace in an API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GlobalSchemaContract" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GlobalSchemaContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/GlobalSchemaContract" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked" + }, + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "location": { + "type": "string", + "description": "Location header" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceSchema": { + "$ref": "./examples/ApiManagementCreateWorkspaceSchema.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/GlobalSchemaContract" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "WorkspaceGlobalSchema_Delete", + "tags": [ + "WorkspaceGlobalSchema" + ], + "description": "Deletes specific Schema.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceSchema": { + "$ref": "./examples/ApiManagementDeleteWorkspaceSchema.json" + } + } + }, + "head": { + "operationId": "WorkspaceGlobalSchema_GetEntityTag", + "tags": [ + "WorkspaceGlobalSchema" + ], + "description": "Gets the entity state (Etag) version of the Schema specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "schemaId", + "in": "path", + "description": "Schema id identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceSchema": { + "$ref": "./examples/ApiManagementHeadWorkspaceSchema.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions": { + "get": { + "operationId": "WorkspaceSubscription_List", + "tags": [ + "WorkspaceSubscription" + ], + "description": "Lists all subscriptions of the workspace in an API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SubscriptionCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceSubscriptions": { + "$ref": "./examples/ApiManagementListWorkspaceSubscriptions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}": { + "get": { + "operationId": "WorkspaceSubscription_Get", + "tags": [ + "WorkspaceSubscription" + ], + "description": "Gets the specified Subscription entity.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SubscriptionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceSubscription": { + "$ref": "./examples/ApiManagementGetWorkspaceSubscription.json" + } + } + }, + "put": { + "operationId": "WorkspaceSubscription_CreateOrUpdate", + "tags": [ + "WorkspaceSubscription" + ], + "description": "Creates or updates the subscription of specified user to the specified product.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "notify", + "in": "query", + "description": "Notify change in Subscription State.\n- If false, do not send any email notification for change of state of subscription\n- If true, send email notification of change of state of subscription", + "required": false, + "type": "boolean" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "appType", + "in": "query", + "description": "Determines the type of application which send the create user request. Default is legacy publisher portal.", + "required": false, + "type": "string", + "enum": [ + "portal", + "developerPortal" + ], + "x-ms-enum": { + "name": "AppType", + "modelAsString": true, + "values": [ + { + "name": "portal", + "value": "portal", + "description": "User create request was sent by legacy developer portal." + }, + { + "name": "developerPortal", + "value": "developerPortal", + "description": "User create request was sent by new developer portal." + } + ] + } + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SubscriptionCreateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SubscriptionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/SubscriptionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceSubscription": { + "$ref": "./examples/ApiManagementCreateWorkspaceSubscription.json" + } + } + }, + "patch": { + "operationId": "WorkspaceSubscription_Update", + "tags": [ + "WorkspaceSubscription" + ], + "description": "Updates the details of a subscription specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "notify", + "in": "query", + "description": "Notify change in Subscription State.\n- If false, do not send any email notification for change of state of subscription\n- If true, send email notification of change of state of subscription", + "required": false, + "type": "boolean" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "appType", + "in": "query", + "description": "Determines the type of application which send the create user request. Default is legacy publisher portal.", + "required": false, + "type": "string", + "enum": [ + "portal", + "developerPortal" + ], + "x-ms-enum": { + "name": "AppType", + "modelAsString": true, + "values": [ + { + "name": "portal", + "value": "portal", + "description": "User create request was sent by legacy developer portal." + }, + { + "name": "developerPortal", + "value": "developerPortal", + "description": "User create request was sent by new developer portal." + } + ] + } + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SubscriptionUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SubscriptionContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateWorkspaceSubscription": { + "$ref": "./examples/ApiManagementUpdateWorkspaceSubscription.json" + } + } + }, + "delete": { + "operationId": "WorkspaceSubscription_Delete", + "tags": [ + "WorkspaceSubscription" + ], + "description": "Deletes the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceSubscription": { + "$ref": "./examples/ApiManagementDeleteWorkspaceSubscription.json" + } + } + }, + "head": { + "operationId": "WorkspaceSubscription_GetEntityTag", + "tags": [ + "WorkspaceSubscription" + ], + "description": "Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceSubscription": { + "$ref": "./examples/ApiManagementHeadWorkspaceSubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/listSecrets": { + "post": { + "operationId": "WorkspaceSubscription_ListSecrets", + "tags": [ + "WorkspaceSubscription" + ], + "description": "Gets the specified Subscription keys.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SubscriptionKeysContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementWorkspaceSubscriptionListSecrets": { + "$ref": "./examples/ApiManagementWorkspaceSubscriptionListSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/regeneratePrimaryKey": { + "post": { + "operationId": "WorkspaceSubscription_RegeneratePrimaryKey", + "tags": [ + "WorkspaceSubscription" + ], + "description": "Regenerates primary key of existing subscription of the workspace in an API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey": { + "$ref": "./examples/ApiManagementWorkspaceSubscriptionRegeneratePrimaryKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}/regenerateSecondaryKey": { + "post": { + "operationId": "WorkspaceSubscription_RegenerateSecondaryKey", + "tags": [ + "WorkspaceSubscription" + ], + "description": "Regenerates secondary key of existing subscription of the workspace in an API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "sid", + "in": "path", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "required": true, + "type": "string", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "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": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey": { + "$ref": "./examples/ApiManagementWorkspaceSubscriptionRegenerateSecondaryKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags": { + "get": { + "operationId": "WorkspaceTag_ListByService", + "tags": [ + "WorkspaceTag" + ], + "description": "Lists a collection of tags defined within a workspace in a service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + { + "name": "scope", + "in": "query", + "description": "Scope like 'apis', 'products' or 'apis/{apiId}", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceTags": { + "$ref": "./examples/ApiManagementListWorkspaceTags.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}": { + "get": { + "operationId": "WorkspaceTag_Get", + "tags": [ + "WorkspaceTag" + ], + "description": "Gets the details of the tag specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceTag": { + "$ref": "./examples/ApiManagementGetWorkspaceTag.json" + } + } + }, + "put": { + "operationId": "WorkspaceTag_CreateOrUpdate", + "tags": [ + "WorkspaceTag" + ], + "description": "Creates a tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TagCreateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceTag": { + "$ref": "./examples/ApiManagementCreateWorkspaceTag.json" + } + } + }, + "patch": { + "operationId": "WorkspaceTag_Update", + "tags": [ + "WorkspaceTag" + ], + "description": "Updates the details of the tag specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TagCreateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementUpdateWorkspaceTag": { + "$ref": "./examples/ApiManagementUpdateWorkspaceTag.json" + } + } + }, + "delete": { + "operationId": "WorkspaceTag_Delete", + "tags": [ + "WorkspaceTag" + ], + "description": "Deletes specific tag of the workspace in an API Management service instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceTag": { + "$ref": "./examples/ApiManagementDeleteWorkspaceTag.json" + } + } + }, + "head": { + "operationId": "WorkspaceTag_GetEntityState", + "tags": [ + "WorkspaceTag" + ], + "description": "Gets the entity state version of the tag specified by its identifier.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementHeadWorkspaceTag": { + "$ref": "./examples/ApiManagementHeadWorkspaceTag.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/apiLinks": { + "get": { + "operationId": "WorkspaceTagApiLink_ListByProduct", + "tags": [ + "WorkspaceTagApiLink" + ], + "description": "Lists a collection of the API links associated with a tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagApiLinkCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceTagApiLinks": { + "$ref": "./examples/ApiManagementListWorkspaceTagApiLinks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/apiLinks/{apiLinkId}": { + "get": { + "operationId": "WorkspaceTagApiLink_Get", + "tags": [ + "WorkspaceTagApiLink" + ], + "description": "Gets the API link for the tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiLinkId", + "in": "path", + "description": "Tag-API link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagApiLinkContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceTagApiLink": { + "$ref": "./examples/ApiManagementGetWorkspaceTagApiLink.json" + } + } + }, + "put": { + "operationId": "WorkspaceTagApiLink_CreateOrUpdate", + "tags": [ + "WorkspaceTagApiLink" + ], + "description": "Adds an API to the specified tag via link.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiLinkId", + "in": "path", + "description": "Tag-API link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TagApiLinkContract" + } + } + ], + "responses": { + "200": { + "description": "Resource 'TagApiLinkContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/TagApiLinkContract" + } + }, + "201": { + "description": "Resource 'TagApiLinkContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/TagApiLinkContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceTagApiLink": { + "$ref": "./examples/ApiManagementCreateWorkspaceTagApiLink.json" + } + } + }, + "delete": { + "operationId": "WorkspaceTagApiLink_Delete", + "tags": [ + "WorkspaceTagApiLink" + ], + "description": "Deletes the specified API from the specified tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiLinkId", + "in": "path", + "description": "Tag-API link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceTagApiLink": { + "$ref": "./examples/ApiManagementDeleteWorkspaceTagApiLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/operationLinks": { + "get": { + "operationId": "WorkspaceTagOperationLink_ListByProduct", + "tags": [ + "WorkspaceTagOperationLink" + ], + "description": "Lists a collection of the operation links associated with a tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| operationId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagOperationLinkCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceTagOperationLinks": { + "$ref": "./examples/ApiManagementListWorkspaceTagOperationLinks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/operationLinks/{operationLinkId}": { + "get": { + "operationId": "WorkspaceTagOperationLink_Get", + "tags": [ + "WorkspaceTagOperationLink" + ], + "description": "Gets the operation link for the tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationLinkId", + "in": "path", + "description": "Tag-operation link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagOperationLinkContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceTagOperationLink": { + "$ref": "./examples/ApiManagementGetWorkspaceTagOperationLink.json" + } + } + }, + "put": { + "operationId": "WorkspaceTagOperationLink_CreateOrUpdate", + "tags": [ + "WorkspaceTagOperationLink" + ], + "description": "Adds an operation to the specified tag via link.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationLinkId", + "in": "path", + "description": "Tag-operation link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TagOperationLinkContract" + } + } + ], + "responses": { + "200": { + "description": "Resource 'TagOperationLinkContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/TagOperationLinkContract" + } + }, + "201": { + "description": "Resource 'TagOperationLinkContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/TagOperationLinkContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceTagOperationLink": { + "$ref": "./examples/ApiManagementCreateWorkspaceTagOperationLink.json" + } + } + }, + "delete": { + "operationId": "WorkspaceTagOperationLink_Delete", + "tags": [ + "WorkspaceTagOperationLink" + ], + "description": "Deletes the specified operation from the specified tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "operationLinkId", + "in": "path", + "description": "Tag-operation link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceTagOperationLink": { + "$ref": "./examples/ApiManagementDeleteWorkspaceTagOperationLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/productLinks": { + "get": { + "operationId": "WorkspaceTagProductLink_ListByProduct", + "tags": [ + "WorkspaceTagProductLink" + ], + "description": "Lists a collection of the product links associated with a tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "$filter", + "in": "query", + "description": "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Number of records to return.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1 + }, + { + "name": "$skip", + "in": "query", + "description": "Number of records to skip.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagProductLinkCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementListWorkspaceTagProductLinks": { + "$ref": "./examples/ApiManagementListWorkspaceTagProductLinks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/productLinks/{productLinkId}": { + "get": { + "operationId": "WorkspaceTagProductLink_Get", + "tags": [ + "WorkspaceTagProductLink" + ], + "description": "Gets the product link for the tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productLinkId", + "in": "path", + "description": "Tag-product link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagProductLinkContract" + }, + "headers": { + "ETag": { + "type": "string", + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceTagProductLink": { + "$ref": "./examples/ApiManagementGetWorkspaceTagProductLink.json" + } + } + }, + "put": { + "operationId": "WorkspaceTagProductLink_CreateOrUpdate", + "tags": [ + "WorkspaceTagProductLink" + ], + "description": "Adds a product to the specified tag via link.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productLinkId", + "in": "path", + "description": "Tag-product link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Create or update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TagProductLinkContract" + } + } + ], + "responses": { + "200": { + "description": "Resource 'TagProductLinkContract' update operation succeeded", + "schema": { + "$ref": "#/definitions/TagProductLinkContract" + } + }, + "201": { + "description": "Resource 'TagProductLinkContract' create operation succeeded", + "schema": { + "$ref": "#/definitions/TagProductLinkContract" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementCreateWorkspaceTagProductLink": { + "$ref": "./examples/ApiManagementCreateWorkspaceTagProductLink.json" + } + } + }, + "delete": { + "operationId": "WorkspaceTagProductLink_Delete", + "tags": [ + "WorkspaceTagProductLink" + ], + "description": "Deletes the specified product from the specified tag.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "tagId", + "in": "path", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "productLinkId", + "in": "path", + "description": "Tag-product link identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "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": { + "ApiManagementDeleteWorkspaceTagProductLink": { + "$ref": "./examples/ApiManagementDeleteWorkspaceTagProductLink.json" + } + } + } + } + }, + "x-ms-paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?export=true": { + "get": { + "operationId": "ApiExport_Get", + "description": "Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "format", + "in": "query", + "description": "Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes. New formats can be added in the future.", + "required": true, + "type": "string", + "enum": [ + "swagger-link", + "wsdl-link", + "wadl-link", + "openapi-link", + "openapi+json-link" + ], + "x-ms-enum": { + "name": "ExportFormat", + "modelAsString": true, + "values": [ + { + "name": "Swagger", + "value": "swagger-link", + "description": "Export the Api Definition in OpenAPI 2.0 Specification as JSON document to the Storage Blob." + }, + { + "name": "Wsdl", + "value": "wsdl-link", + "description": "Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`" + }, + { + "name": "Wadl", + "value": "wadl-link", + "description": "Export the Api Definition in WADL Schema to Storage Blob." + }, + { + "name": "Openapi", + "value": "openapi-link", + "description": "Export the Api Definition in OpenAPI 3.0 Specification as YAML document to Storage Blob." + }, + { + "name": "OpenapiJson", + "value": "openapi+json-link", + "description": "Export the Api Definition in OpenAPI 3.0 Specification as JSON document to Storage Blob." + } + ] + } + }, + { + "name": "export", + "in": "query", + "description": "Query parameter required to export the API details.", + "required": true, + "type": "string", + "enum": [ + "true" + ], + "x-ms-enum": { + "name": "ExportApi", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiExportResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetApiExportInOpenApi2dot0": { + "$ref": "./examples/ApiManagementGetApiExportInOpenApi2dot0.json" + }, + "ApiManagementGetApiExportInOpenApi3dot0": { + "$ref": "./examples/ApiManagementGetApiExportInOpenApi3dot0.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}?export=true": { + "get": { + "operationId": "WorkspaceApiExport_Get", + "description": "Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the API Management service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" + }, + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier. Must be unique in the current API Management service instance.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "apiId", + "in": "path", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + }, + { + "name": "format", + "in": "query", + "description": "Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes.", + "required": true, + "type": "string", + "enum": [ + "swagger-link", + "wsdl-link", + "wadl-link", + "openapi-link", + "openapi+json-link" + ], + "x-ms-enum": { + "name": "ExportFormat", + "modelAsString": true, + "values": [ + { + "name": "Swagger", + "value": "swagger-link", + "description": "Export the Api Definition in OpenAPI 2.0 Specification as JSON document to the Storage Blob." + }, + { + "name": "Wsdl", + "value": "wsdl-link", + "description": "Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`" + }, + { + "name": "Wadl", + "value": "wadl-link", + "description": "Export the Api Definition in WADL Schema to Storage Blob." + }, + { + "name": "Openapi", + "value": "openapi-link", + "description": "Export the Api Definition in OpenAPI 3.0 Specification as YAML document to Storage Blob." + }, + { + "name": "OpenapiJson", + "value": "openapi+json-link", + "description": "Export the Api Definition in OpenAPI 3.0 Specification as JSON document to Storage Blob." + } + ] + } + }, + { + "name": "export", + "in": "query", + "description": "Query parameter required to export the API details.", + "required": true, + "type": "string", + "enum": [ + "true" + ], + "x-ms-enum": { + "name": "ExportApi", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true" + } + ] + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiExportResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiManagementGetWorkspaceApiExportInOpenApi2dot0": { + "$ref": "./examples/ApiManagementGetWorkspaceApiExportInOpenApi2dot0.json" + }, + "ApiManagementGetWorkspaceApiExportInOpenApi3dot0": { + "$ref": "./examples/ApiManagementGetWorkspaceApiExportInOpenApi3dot0.json" + } + } + } + } + }, + "definitions": { + "AccessIdName": { + "type": "string", + "enum": [ + "access", + "gitAccess" + ], + "x-ms-enum": { + "name": "AccessIdName", + "modelAsString": true, + "values": [ + { + "name": "access", + "value": "access" + }, + { + "name": "gitAccess", + "value": "gitAccess" + } + ] + } + }, + "AccessInformationCollection": { + "type": "object", + "description": "Paged AccessInformation list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/AccessInformationContract" + }, + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "AccessInformationContract": { + "type": "object", + "description": "Tenant Settings.", + "properties": { + "properties": { + "$ref": "#/definitions/AccessInformationContractProperties", + "description": "AccessInformation entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AccessInformationContractProperties": { + "type": "object", + "description": "Tenant access information contract of the API Management service.", + "properties": { + "id": { + "type": "string", + "description": "Access Information type ('access' or 'gitAccess')" + }, + "principalId": { + "type": "string", + "description": "Principal (User) Identifier." + }, + "enabled": { + "type": "boolean", + "description": "Determines whether direct access is enabled." + } + } + }, + "AccessInformationCreateParameterProperties": { + "type": "object", + "description": "Tenant access information update parameters of the API Management service", + "properties": { + "principalId": { + "type": "string", + "description": "Principal (User) Identifier." + }, + "primaryKey": { + "type": "string", + "format": "password", + "description": "Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "x-ms-secret": true + }, + "secondaryKey": { + "type": "string", + "format": "password", + "description": "Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "x-ms-secret": true + }, + "enabled": { + "type": "boolean", + "description": "Determines whether direct access is enabled." + } + } + }, + "AccessInformationCreateParameters": { + "type": "object", + "description": "Tenant access information update parameters.", + "properties": { + "properties": { + "$ref": "#/definitions/AccessInformationCreateParameterProperties", + "description": "Tenant access information update parameter properties.", + "x-ms-client-flatten": true + } + } + }, + "AccessInformationSecretsContract": { + "type": "object", + "description": "Tenant access information contract of the API Management service.", + "properties": { + "id": { + "type": "string", + "description": "Access Information type ('access' or 'gitAccess')" + }, + "principalId": { + "type": "string", + "description": "Principal (User) Identifier." + }, + "primaryKey": { + "type": "string", + "format": "password", + "description": "Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "x-ms-secret": true + }, + "secondaryKey": { + "type": "string", + "format": "password", + "description": "Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "x-ms-secret": true + }, + "enabled": { + "type": "boolean", + "description": "Determines whether direct access is enabled." + } + } + }, + "AccessInformationUpdateParameterProperties": { + "type": "object", + "description": "Tenant access information update parameters of the API Management service", + "properties": { + "enabled": { + "type": "boolean", + "description": "Determines whether direct access is enabled." + } + } + }, + "AccessInformationUpdateParameters": { + "type": "object", + "description": "Tenant access information update parameters.", + "properties": { + "properties": { + "$ref": "#/definitions/AccessInformationUpdateParameterProperties", + "description": "Tenant access information update parameter properties.", + "x-ms-client-flatten": true + } + } + }, + "AccessType": { + "type": "string", + "description": "The type of access to be used for the storage account.", + "enum": [ + "AccessKey", + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity" + ], + "x-ms-enum": { + "name": "AccessType", + "modelAsString": true, + "values": [ + { + "name": "AccessKey", + "value": "AccessKey", + "description": "Use access key." + }, + { + "name": "SystemAssignedManagedIdentity", + "value": "SystemAssignedManagedIdentity", + "description": "Use system assigned managed identity." + }, + { + "name": "UserAssignedManagedIdentity", + "value": "UserAssignedManagedIdentity", + "description": "Use user assigned managed identity." + } + ] + } + }, + "AdditionalLocation": { + "type": "object", + "description": "Description of an additional API Management resource location.", + "properties": { + "location": { + "type": "string", + "description": "The location name of the additional region among Azure Data center regions." + }, + "sku": { + "$ref": "#/definitions/ApiManagementServiceSkuProperties", + "description": "SKU properties of the API Management service." + }, + "zones": { + "type": "array", + "description": "A list of availability zones denoting where the resource needs to come from.", + "items": { + "type": "string" + } + }, + "publicIPAddresses": { + "type": "array", + "description": "Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privateIPAddresses": { + "type": "array", + "description": "Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "publicIpAddressId": { + "type": "string", + "description": "Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network." + }, + "virtualNetworkConfiguration": { + "$ref": "#/definitions/VirtualNetworkConfiguration", + "description": "Virtual network configuration for the location." + }, + "gatewayRegionalUrl": { + "type": "string", + "description": "Gateway URL of the API Management service in the Region.", + "readOnly": true + }, + "natGatewayState": { + "type": "string", + "description": "Property can be used to enable NAT Gateway for this API Management service.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "NatGatewayState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Nat Gateway is enabled for the service." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Nat Gateway is disabled for the service." + } + ] + } + }, + "outboundPublicIPAddresses": { + "type": "array", + "description": "Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "disableGateway": { + "type": "boolean", + "description": "Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.", + "default": false + }, + "platformVersion": { + "$ref": "#/definitions/PlatformVersion", + "description": "Compute Platform Version running the service.", + "readOnly": true + } + }, + "required": [ + "location", + "sku" + ] + }, + "AllPoliciesCollection": { + "type": "object", + "description": "The response of All Policies.", + "properties": { + "value": { + "type": "array", + "description": "AllPolicies Contract value.", + "items": { + "$ref": "#/definitions/AllPoliciesContract" + } + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "AllPoliciesContract": { + "type": "object", + "description": "AllPolicies Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/AllPoliciesContractProperties", + "description": "Properties of the All Policies.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AllPoliciesContractProperties": { + "type": "object", + "description": "AllPolicies Properties.", + "properties": { + "referencePolicyId": { + "type": "string", + "description": "Policy Identifier" + }, + "complianceState": { + "type": "string", + "description": "Policy Restriction Compliance State", + "default": "Pending", + "enum": [ + "Pending", + "NonCompliant", + "Compliant" + ], + "x-ms-enum": { + "name": "PolicyComplianceState", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "The policy restriction compliance state has not yet been determined." + }, + { + "name": "NonCompliant", + "value": "NonCompliant", + "description": "The scope in restriction is out of compliance." + }, + { + "name": "Compliant", + "value": "Compliant", + "description": "The scope in restriction is in compliance." + } + ] + } + } + } + }, + "AlwaysLog": { + "type": "string", + "description": "Specifies for what type of messages sampling settings should not apply.", + "enum": [ + "allErrors" + ], + "x-ms-enum": { + "name": "AlwaysLog", + "modelAsString": true, + "values": [ + { + "name": "allErrors", + "value": "allErrors", + "description": "Always log all erroneous request regardless of sampling settings." + } + ] + } + }, + "ApiCollection": { + "type": "object", + "description": "Paged API list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/ApiContract" + }, + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "ApiContactInformation": { + "type": "object", + "description": "API contact information", + "properties": { + "name": { + "type": "string", + "description": "The identifying name of the contact person/organization" + }, + "url": { + "type": "string", + "description": "The URL pointing to the contact information. MUST be in the format of a URL" + }, + "email": { + "type": "string", + "description": "The email address of the contact person/organization. MUST be in the format of an email address" + } + } + }, + "ApiContract": { + "type": "object", + "description": "API details.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiContractProperties", + "description": "API entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ApiContractProperties": { + "type": "object", + "description": "API Entity Properties", + "properties": { + "sourceApiId": { + "type": "string", + "description": "API identifier of the source API." + }, + "displayName": { + "type": "string", + "description": "API name. Must be 1 to 300 characters long.", + "minLength": 1, + "maxLength": 300 + }, + "serviceUrl": { + "type": "string", + "description": "Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.", + "minLength": 0, + "maxLength": 2000 + }, + "path": { + "type": "string", + "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.", + "minLength": 0, + "maxLength": 400 + }, + "protocols": { + "type": "array", + "description": "Describes on which protocols the operations in this API can be invoked.", + "items": { + "$ref": "#/definitions/Protocol" + } + }, + "apiVersionSet": { + "$ref": "#/definitions/ApiVersionSetContractDetails", + "description": "Version set details" + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state", + "readOnly": true + } + }, + "required": [ + "path" + ], + "allOf": [ + { + "$ref": "#/definitions/ApiEntityBaseContract" + } + ] + }, + "ApiContractUpdateProperties": { + "type": "object", + "description": "API update contract properties.", + "properties": { + "displayName": { + "type": "string", + "description": "API name.", + "minLength": 1, + "maxLength": 300 + }, + "serviceUrl": { + "type": "string", + "description": "Absolute URL of the backend service implementing this API.", + "minLength": 1, + "maxLength": 2000 + }, + "path": { + "type": "string", + "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.", + "minLength": 0, + "maxLength": 400 + }, + "protocols": { + "type": "array", + "description": "Describes on which protocols the operations in this API can be invoked.", + "items": { + "$ref": "#/definitions/Protocol" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiEntityBaseContract" + } + ] + }, + "ApiCreateOrUpdateParameter": { + "type": "object", + "description": "API Create or Update Parameters.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiCreateOrUpdateProperties", + "description": "API entity create of update properties.", + "x-ms-client-flatten": true + } + } + }, + "ApiCreateOrUpdateProperties": { + "type": "object", + "description": "API Create or Update Properties.", + "properties": { + "value": { + "type": "string", + "description": "Content value when Importing an API." + }, + "format": { + "$ref": "#/definitions/ContentFormat", + "description": "Format of the Content in which the API is getting imported. New formats can be added in the future" + }, + "wsdlSelector": { + "$ref": "#/definitions/ApiCreateOrUpdatePropertiesWsdlSelector", + "description": "Criteria to limit import of WSDL to a subset of the document." + }, + "apiType": { + "$ref": "#/definitions/SoapApiType", + "description": "Type of API to create.\n* `http` creates a REST API\n* `soap` creates a SOAP pass-through API\n* `websocket` creates websocket API\n* `graphql` creates GraphQL API.\nNew types can be added in the future.", + "x-ms-client-name": "SoapApiType" + }, + "translateRequiredQueryParameters": { + "$ref": "#/definitions/TranslateRequiredQueryParametersConduct", + "description": "Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'", + "x-ms-client-name": "TranslateRequiredQueryParametersConduct" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiContractProperties" + } + ] + }, + "ApiCreateOrUpdatePropertiesWsdlSelector": { + "type": "object", + "description": "Criteria to limit import of WSDL to a subset of the document.", + "properties": { + "wsdlServiceName": { + "type": "string", + "description": "Name of service to import from WSDL" + }, + "wsdlEndpointName": { + "type": "string", + "description": "Name of endpoint(port) to import from WSDL" + } + } + }, + "ApiEntityBaseContract": { + "type": "object", + "description": "API base contract details.", + "properties": { + "description": { + "type": "string", + "description": "Description of the API. May include HTML formatting tags." + }, + "authenticationSettings": { + "$ref": "#/definitions/AuthenticationSettingsContract", + "description": "Collection of authentication settings included into this API." + }, + "subscriptionKeyParameterNames": { + "$ref": "#/definitions/SubscriptionKeyParameterNamesContract", + "description": "Protocols over which API is made available." + }, + "type": { + "$ref": "#/definitions/ApiType", + "description": "Type of API.", + "x-ms-client-name": "ApiType" + }, + "apiRevision": { + "type": "string", + "description": "Describes the revision of the API. If no value is provided, default revision 1 is created", + "minLength": 1, + "maxLength": 100 + }, + "apiVersion": { + "type": "string", + "description": "Indicates the version identifier of the API if the API is versioned", + "maxLength": 100 + }, + "isCurrent": { + "type": "boolean", + "description": "Indicates if API revision is current api revision." + }, + "isOnline": { + "type": "boolean", + "description": "Indicates if API revision is accessible via the gateway.", + "readOnly": true + }, + "apiRevisionDescription": { + "type": "string", + "description": "Description of the API Revision.", + "maxLength": 256 + }, + "apiVersionDescription": { + "type": "string", + "description": "Description of the API Version.", + "maxLength": 256 + }, + "apiVersionSetId": { + "type": "string", + "description": "A resource identifier for the related ApiVersionSet." + }, + "subscriptionRequired": { + "type": "boolean", + "description": "Specifies whether an API or Product subscription is required for accessing the API." + }, + "termsOfServiceUrl": { + "type": "string", + "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL." + }, + "contact": { + "$ref": "#/definitions/ApiContactInformation", + "description": "Contact information for the API." + }, + "license": { + "$ref": "#/definitions/ApiLicenseInformation", + "description": "License information for the API." + } + } + }, + "ApiExportResult": { + "type": "object", + "description": "API Export result.", + "properties": { + "id": { + "type": "string", + "description": "ResourceId of the API which was exported." + }, + "format": { + "$ref": "#/definitions/ExportResultFormat", + "description": "Format in which the API Details are exported to the Storage Blob with Sas Key valid for 5 minutes.", + "x-ms-client-name": "ExportResultFormat" + }, + "value": { + "$ref": "#/definitions/ApiExportResultValue", + "description": "The object defining the schema of the exported API Detail" + } + } + }, + "ApiExportResultValue": { + "type": "object", + "description": "The object defining the schema of the exported API Detail", + "properties": { + "link": { + "type": "string", + "description": "Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes." + } + } + }, + "ApiGatewaySkuType": { + "type": "string", + "description": "Name of the Sku.", + "enum": [ + "Standard", + "WorkspaceGatewayStandard", + "WorkspaceGatewayPremium" + ], + "x-ms-enum": { + "name": "ApiGatewaySkuType", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard", + "description": "Standard SKU of the API gateway." + }, + { + "name": "WorkspaceGatewayStandard", + "value": "WorkspaceGatewayStandard", + "description": "Standard SKU of the API gateway to be used in Workspaces." + }, + { + "name": "WorkspaceGatewayPremium", + "value": "WorkspaceGatewayPremium", + "description": "Premium SKU of the API gateway to be used in Workspaces." + } + ] + } + }, + "ApiLicenseInformation": { + "type": "object", + "description": "API license information", + "properties": { + "name": { + "type": "string", + "description": "The license name used for the API" + }, + "url": { + "type": "string", + "description": "A URL to the license used for the API. MUST be in the format of a URL" + } + } + }, + "ApiManagementGatewayBaseProperties": { + "type": "object", + "description": "Base Properties of an API Management gateway resource description.", + "properties": { + "provisioningState": { + "type": "string", + "description": "The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.", + "readOnly": true + }, + "targetProvisioningState": { + "type": "string", + "description": "The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.", + "readOnly": true + }, + "createdAtUtc": { + "type": "string", + "format": "date-time", + "description": "Creation UTC date of the API Management gateway.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.", + "readOnly": true + }, + "frontend": { + "$ref": "#/definitions/FrontendConfiguration", + "description": "Information regarding how the gateway should be exposed." + }, + "backend": { + "$ref": "#/definitions/BackendConfiguration", + "description": "Information regarding how the gateway should integrate with backend systems." + }, + "configurationApi": { + "$ref": "#/definitions/GatewayConfigurationApi", + "description": "Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU." + }, + "virtualNetworkType": { + "$ref": "#/definitions/VirtualNetworkType", + "description": "The type of VPN in which API Management gateway needs to be configured in." + } + } + }, + "ApiManagementGatewayConfigConnectionListResult": { + "type": "object", + "description": "The response of the List API Management gateway operation.", + "properties": { + "value": { + "type": "array", + "description": "Result of the List API Management gateway config connection operation.", + "items": { + "$ref": "#/definitions/ApiManagementGatewayConfigConnectionResource" + } + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." + } + }, + "required": [ + "value" + ] + }, + "ApiManagementGatewayConfigConnectionResource": { + "type": "object", + "description": "A single API Management gateway resource in List or Get response.", + "properties": { + "properties": { + "$ref": "#/definitions/GatewayConfigConnectionBaseProperties", + "description": "Properties of the API Management gateway config connection.", + "x-ms-client-flatten": true + }, + "etag": { + "$ref": "#/definitions/Azure.Core.eTag", + "description": "ETag of the resource.", + "readOnly": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ApiManagementGatewayListResult": { + "type": "object", + "description": "The response of the List API Management gateway operation.", + "properties": { + "value": { + "type": "array", + "description": "Result of the List API Management gateway operation.", + "items": { + "$ref": "#/definitions/ApiManagementGatewayResource" + } + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." + } + }, + "required": [ + "value" + ] + }, + "ApiManagementGatewayProperties": { + "type": "object", + "description": "Properties of an API Management gateway resource description.", + "allOf": [ + { + "$ref": "#/definitions/ApiManagementGatewayBaseProperties" + } + ] + }, + "ApiManagementGatewayResource": { + "type": "object", + "description": "A single API Management gateway resource in List or Get response.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiManagementGatewayProperties", + "description": "Properties of the API Management gateway.", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/ApiManagementGatewaySkuProperties", + "description": "SKU properties of the API Management gateway." + }, + "etag": { + "$ref": "#/definitions/Azure.Core.eTag", + "description": "ETag of the resource.", + "readOnly": true + } + }, + "required": [ + "properties", + "sku" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ApiManagementGatewaySkuProperties": { + "type": "object", + "description": "API Management gateway resource SKU properties.", + "properties": { + "name": { + "$ref": "#/definitions/ApiGatewaySkuType", + "description": "Name of the Sku." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Capacity of the SKU (number of deployed units of the SKU)" + } + }, + "required": [ + "name" + ] + }, + "ApiManagementGatewaySkuPropertiesForPatch": { + "type": "object", + "description": "API Management gateway resource SKU properties for PATCH operations given nothing should be required.", + "properties": { + "name": { + "$ref": "#/definitions/ApiGatewaySkuType", + "description": "Name of the Sku." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Capacity of the SKU (number of deployed units of the SKU)" + } + } + }, + "ApiManagementGatewayUpdateParameters": { + "type": "object", + "description": "Parameter supplied to Update API Management gateway.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiManagementGatewayUpdateProperties", + "description": "Properties of the API Management gateway.", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/ApiManagementGatewaySkuPropertiesForPatch", + "description": "SKU properties of the API Management gateway." + }, + "etag": { + "type": "string", + "description": "ETag of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApimResource" + } + ] + }, + "ApiManagementGatewayUpdateProperties": { + "type": "object", + "description": "Properties of an API Management gateway resource description.", + "allOf": [ + { + "$ref": "#/definitions/ApiManagementGatewayBaseProperties" + } + ] + }, + "ApiManagementServiceApplyNetworkConfigurationParameters": { + "type": "object", + "description": "Parameter supplied to the Apply Network configuration operation.", + "properties": { + "location": { + "type": "string", + "description": "Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required." + } + } + }, + "ApiManagementServiceBackupRestoreParameters": { + "type": "object", + "description": "Parameters supplied to the Backup/Restore of an API Management service operation.", + "properties": { + "storageAccount": { + "type": "string", + "description": "The name of the Azure storage account (used to place/retrieve the backup)." + }, + "containerName": { + "type": "string", + "description": "The name of the blob container (used to place/retrieve the backup)." + }, + "backupName": { + "type": "string", + "description": "The name of the backup file to create/retrieve." + }, + "accessType": { + "type": "string", + "description": "The type of access to be used for the storage account.", + "default": "AccessKey", + "enum": [ + "AccessKey", + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity" + ], + "x-ms-enum": { + "name": "AccessType", + "modelAsString": true, + "values": [ + { + "name": "AccessKey", + "value": "AccessKey", + "description": "Use access key." + }, + { + "name": "SystemAssignedManagedIdentity", + "value": "SystemAssignedManagedIdentity", + "description": "Use system assigned managed identity." + }, + { + "name": "UserAssignedManagedIdentity", + "value": "UserAssignedManagedIdentity", + "description": "Use user assigned managed identity." + } + ] + } + }, + "accessKey": { + "type": "string", + "description": "Storage account access key. Required only if `accessType` is set to `AccessKey`." + }, + "clientId": { + "type": "string", + "description": "The Client ID of user assigned managed identity. Required only if `accessType` is set to `UserAssignedManagedIdentity`." + } + }, + "required": [ + "storageAccount", + "containerName", + "backupName" + ] + }, + "ApiManagementServiceBaseProperties": { + "type": "object", + "description": "Base Properties of an API Management service resource description.", + "properties": { + "notificationSenderEmail": { + "type": "string", + "description": "Email address from which the notification will be sent.", + "maxLength": 100 + }, + "provisioningState": { + "type": "string", + "description": "The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.", + "readOnly": true + }, + "targetProvisioningState": { + "type": "string", + "description": "The provisioning state of the API Management service, which is targeted by the long running operation started on the service.", + "readOnly": true + }, + "createdAtUtc": { + "type": "string", + "format": "date-time", + "description": "Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.", + "readOnly": true + }, + "gatewayUrl": { + "type": "string", + "description": "Gateway URL of the API Management service.", + "readOnly": true + }, + "gatewayRegionalUrl": { + "type": "string", + "description": "Gateway URL of the API Management service in the Default Region.", + "readOnly": true + }, + "portalUrl": { + "type": "string", + "description": "Publisher portal endpoint Url of the API Management service.", + "readOnly": true + }, + "managementApiUrl": { + "type": "string", + "description": "Management API endpoint URL of the API Management service.", + "readOnly": true + }, + "scmUrl": { + "type": "string", + "description": "SCM endpoint URL of the API Management service.", + "readOnly": true + }, + "developerPortalUrl": { + "type": "string", + "description": "DEveloper Portal endpoint URL of the API Management service.", + "readOnly": true + }, + "hostnameConfigurations": { + "type": "array", + "description": "Custom hostname configuration of the API Management service.", + "items": { + "$ref": "#/definitions/HostnameConfiguration" + }, + "x-ms-identifiers": [ + "hostName", + "type" + ] + }, + "publicIPAddresses": { + "type": "array", + "description": "Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privateIPAddresses": { + "type": "array", + "description": "Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "publicIpAddressId": { + "type": "string", + "description": "Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network." + }, + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'" + }, + "configurationApi": { + "$ref": "#/definitions/ConfigurationApi", + "description": "Configuration API configuration of the API Management service." + }, + "virtualNetworkConfiguration": { + "$ref": "#/definitions/VirtualNetworkConfiguration", + "description": "Virtual network configuration of the API Management service." + }, + "additionalLocations": { + "type": "array", + "description": "Additional datacenter locations of the API Management service.", + "items": { + "$ref": "#/definitions/AdditionalLocation" + }, + "x-ms-identifiers": [ + "location", + "sku" + ] + }, + "customProperties": { + "type": "object", + "description": "Custom properties of the API Management service.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` can be used to disable just TLS 1.1 for communications with backends.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` can be used to disable TLS 1.0 for communications with backends.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` can be used to enable HTTP2 protocol on an API Management service.
Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is `True` if the service was created on or before April 1, 2018 and `False` otherwise. Http2 setting's default value is `False`.

You can disable any of the following ciphers by using settings `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. The default value is `true` for them.
Note: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "additionalProperties": { + "type": "string" + } + }, + "certificates": { + "type": "array", + "description": "List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.", + "items": { + "$ref": "#/definitions/CertificateConfiguration" + }, + "x-ms-identifiers": [ + "certificate/thumbprint" + ] + }, + "enableClientCertificate": { + "type": "boolean", + "description": "Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.", + "default": false + }, + "natGatewayState": { + "type": "string", + "description": "Property can be used to enable NAT Gateway for this API Management service.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "NatGatewayState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Nat Gateway is enabled for the service." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Nat Gateway is disabled for the service." + } + ] + } + }, + "outboundPublicIPAddresses": { + "type": "array", + "description": "Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "disableGateway": { + "type": "boolean", + "description": "Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.", + "default": false + }, + "virtualNetworkType": { + "type": "string", + "description": "The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", + "default": "None", + "enum": [ + "None", + "External", + "Internal" + ], + "x-ms-enum": { + "name": "VirtualNetworkType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "The API Management gateway is not part of any Virtual Network." + }, + { + "name": "External", + "value": "External", + "description": "The API Management gateway is part of Virtual Network and it is accessible from Internet." + }, + { + "name": "Internal", + "value": "Internal", + "description": "The API Management gateway is part of Virtual Network and it is only accessible from within the virtual network." + } + ] + } + }, + "apiVersionConstraint": { + "$ref": "#/definitions/ApiVersionConstraint", + "description": "Control Plane Apis version constraint for the API Management service." + }, + "restore": { + "type": "boolean", + "description": "Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.", + "default": false + }, + "privateEndpointConnections": { + "type": "array", + "description": "List of Private Endpoint Connections of this service.", + "items": { + "$ref": "#/definitions/RemotePrivateEndpointConnectionWrapper" + } + }, + "platformVersion": { + "$ref": "#/definitions/PlatformVersion", + "description": "Compute Platform Version running the service in this location.", + "readOnly": true + }, + "legacyPortalStatus": { + "type": "string", + "description": "Status of legacy portal in the API Management service.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LegacyPortalStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Legacy Portal is enabled for the service." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Legacy Portal is disabled for the service." + } + ] + } + }, + "developerPortalStatus": { + "type": "string", + "description": "Status of developer portal in this API Management service.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DeveloperPortalStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Developer Portal is enabled for the service." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Developer Portal is disabled for the service." + } + ] + } + }, + "releaseChannel": { + "$ref": "#/definitions/ReleaseChannel", + "description": "Release Channel of this API Management service." + } + } + }, + "ApiManagementServiceCheckNameAvailabilityParameters": { + "type": "object", + "description": "Parameters supplied to the CheckNameAvailability operation.", + "properties": { + "name": { + "type": "string", + "description": "The name to check for availability." + } + }, + "required": [ + "name" + ] + }, + "ApiManagementServiceGetDomainOwnershipIdentifierResult": { + "type": "object", + "description": "Response of the GetDomainOwnershipIdentifier operation.", + "properties": { + "domainOwnershipIdentifier": { + "type": "string", + "description": "The domain ownership identifier value.", + "readOnly": true + } + } + }, + "ApiManagementServiceGetSsoTokenResult": { + "type": "object", + "description": "The response of the GetSsoToken operation.", + "properties": { + "redirectUri": { + "type": "string", + "description": "Redirect URL to the Publisher Portal containing the SSO token." + } + } + }, + "ApiManagementServiceIdentity": { + "type": "object", + "description": "Identity properties of the Api Management service resource.", + "properties": { + "type": { + "$ref": "#/definitions/ApimIdentityType", + "description": "The type of identity used for the resource. 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 service." + }, + "principalId": { + "type": "string", + "format": "uuid", + "description": "The principal id of the identity.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The client tenant id of the identity.", + "readOnly": true + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "additionalProperties": { + "$ref": "#/definitions/UserIdentityProperties" + } + } + }, + "required": [ + "type" + ] + }, + "ApiManagementServiceListResult": { + "type": "object", + "description": "The response of the List API Management services operation.", + "properties": { + "value": { + "type": "array", + "description": "Result of the List API Management services operation.", + "items": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." + } + }, + "required": [ + "value" + ] + }, + "ApiManagementServiceNameAvailabilityResult": { + "type": "object", + "description": "Response of the CheckNameAvailability operation.", + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "True if the name is available and can be used to create a new API Management service; otherwise false.", + "readOnly": true + }, + "message": { + "type": "string", + "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 is already in use, and direct them to select a different name.", + "readOnly": true + }, + "reason": { + "$ref": "#/definitions/NameAvailabilityReason", + "description": "Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable." + } + } + }, + "ApiManagementServiceProperties": { + "type": "object", + "description": "Properties of an API Management service resource description.", + "properties": { + "publisherEmail": { + "type": "string", + "description": "Publisher email.", + "maxLength": 100 + }, + "publisherName": { + "type": "string", + "description": "Publisher name.", + "maxLength": 100 + } + }, + "required": [ + "publisherEmail", + "publisherName" + ], + "allOf": [ + { + "$ref": "#/definitions/ApiManagementServiceBaseProperties" + } + ] + }, + "ApiManagementServiceResource": { + "type": "object", + "description": "A single API Management service resource in List or Get response.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiManagementServiceProperties", + "description": "Properties of the API Management service.", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/ApiManagementServiceSkuProperties", + "description": "SKU properties of the API Management service." + }, + "identity": { + "$ref": "#/definitions/ApiManagementServiceIdentity", + "description": "Managed service identity of the Api Management service." + }, + "etag": { + "$ref": "#/definitions/Azure.Core.eTag", + "description": "ETag of the resource.", + "readOnly": true + }, + "zones": { + "type": "array", + "description": "The availability zones.", + "items": { + "type": "string" + } + } + }, + "required": [ + "properties", + "sku" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ApiManagementServiceSkuProperties": { + "type": "object", + "description": "API Management service resource SKU properties.", + "properties": { + "name": { + "$ref": "#/definitions/SkuType", + "description": "Name of the Sku." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0." + } + }, + "required": [ + "name", + "capacity" + ] + }, + "ApiManagementServiceUpdateParameters": { + "type": "object", + "description": "Parameter supplied to Update Api Management Service.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiManagementServiceUpdateProperties", + "description": "Properties of the API Management service.", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/ApiManagementServiceSkuProperties", + "description": "SKU properties of the API Management service." + }, + "identity": { + "$ref": "#/definitions/ApiManagementServiceIdentity", + "description": "Managed service identity of the Api Management service." + }, + "etag": { + "type": "string", + "description": "ETag of the resource.", + "readOnly": true + }, + "zones": { + "type": "array", + "description": "A list of availability zones denoting where the resource needs to come from.", + "items": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApimResource" + } + ] + }, + "ApiManagementServiceUpdateProperties": { + "type": "object", + "description": "Properties of an API Management service resource description.", + "properties": { + "publisherEmail": { + "type": "string", + "description": "Publisher email.", + "maxLength": 100 + }, + "publisherName": { + "type": "string", + "description": "Publisher name.", + "maxLength": 100 + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiManagementServiceBaseProperties" + } + ] + }, + "ApiManagementSku": { + "type": "object", + "description": "Describes an available ApiManagement SKU.", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource the SKU applies to.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of SKU.", + "readOnly": true + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic**", + "readOnly": true + }, + "size": { + "type": "string", + "description": "The Size of the SKU.", + "readOnly": true + }, + "family": { + "type": "string", + "description": "The Family of this particular SKU.", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "The Kind of resources that are supported in this SKU.", + "readOnly": true + }, + "capacity": { + "$ref": "#/definitions/ApiManagementSkuCapacity", + "description": "Specifies the number of virtual machines in the scale set.", + "readOnly": true + }, + "locations": { + "type": "array", + "description": "The set of locations that the SKU is available.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "locationInfo": { + "type": "array", + "description": "A list of locations and availability zones in those locations where the SKU is available.", + "items": { + "$ref": "#/definitions/ApiManagementSkuLocationInfo" + }, + "readOnly": true, + "x-ms-identifiers": [ + "location" + ] + }, + "apiVersions": { + "type": "array", + "description": "The api versions that support this SKU.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "costs": { + "type": "array", + "description": "Metadata for retrieving price info.", + "items": { + "$ref": "#/definitions/ApiManagementSkuCosts" + }, + "readOnly": true, + "x-ms-identifiers": [ + "meterID" + ] + }, + "capabilities": { + "type": "array", + "description": "A name value pair to describe the capability.", + "items": { + "$ref": "#/definitions/ApiManagementSkuCapabilities" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "restrictions": { + "type": "array", + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.", + "items": { + "$ref": "#/definitions/ApiManagementSkuRestrictions" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ApiManagementSkuCapabilities": { + "type": "object", + "description": "Describes The SKU capabilities object.", + "properties": { + "name": { + "type": "string", + "description": "An invariant to describe the feature.", + "readOnly": true + }, + "value": { + "type": "string", + "description": "An invariant if the feature is measured by quantity.", + "readOnly": true + } + } + }, + "ApiManagementSkuCapacity": { + "type": "object", + "description": "Describes scaling information of a SKU.", + "properties": { + "minimum": { + "type": "integer", + "format": "int32", + "description": "The minimum capacity.", + "readOnly": true + }, + "maximum": { + "type": "integer", + "format": "int32", + "description": "The maximum capacity that can be set.", + "readOnly": true + }, + "default": { + "type": "integer", + "format": "int32", + "description": "The default capacity.", + "readOnly": true + }, + "scaleType": { + "$ref": "#/definitions/ApiManagementSkuCapacityScaleType", + "description": "The scale type applicable to the sku.", + "readOnly": true + } + } + }, + "ApiManagementSkuCapacityScaleType": { + "type": "string", + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "x-ms-enum": { + "name": "ApiManagementSkuCapacityScaleType", + "modelAsString": false + } + }, + "ApiManagementSkuCosts": { + "type": "object", + "description": "Describes metadata for retrieving price info.", + "properties": { + "meterID": { + "type": "string", + "description": "Used for querying price from commerce.", + "readOnly": true + }, + "quantity": { + "type": "integer", + "format": "int64", + "description": "The multiplier is needed to extend the base metered cost.", + "readOnly": true + }, + "extendedUnit": { + "type": "string", + "description": "An invariant to show the extended unit.", + "readOnly": true + } + } + }, + "ApiManagementSkuLocationInfo": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Location of the SKU", + "readOnly": true + }, + "zones": { + "type": "array", + "description": "List of availability zones where the SKU is supported.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "zoneDetails": { + "type": "array", + "description": "Details of capabilities available to a SKU in specific zones.", + "items": { + "$ref": "#/definitions/ApiManagementSkuZoneDetails" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ApiManagementSkuRestrictionInfo": { + "type": "object", + "properties": { + "locations": { + "type": "array", + "description": "Locations where the SKU is restricted", + "items": { + "type": "string" + }, + "readOnly": true + }, + "zones": { + "type": "array", + "description": "List of availability zones where the SKU is restricted.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "ApiManagementSkuRestrictions": { + "type": "object", + "description": "Describes scaling information of a SKU.", + "properties": { + "type": { + "$ref": "#/definitions/ApiManagementSkuRestrictionsType", + "description": "The type of restrictions.", + "readOnly": true + }, + "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" + }, + "readOnly": true + }, + "restrictionInfo": { + "$ref": "#/definitions/ApiManagementSkuRestrictionInfo", + "description": "The information about the restriction where the SKU cannot be used.", + "readOnly": true + }, + "reasonCode": { + "$ref": "#/definitions/ApiManagementSkuRestrictionsReasonCode", + "description": "The reason for restriction.", + "readOnly": true + } + } + }, + "ApiManagementSkuRestrictionsReasonCode": { + "type": "string", + "description": "The reason for restriction.", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ApiManagementSkuRestrictionsReasonCode", + "modelAsString": false + } + }, + "ApiManagementSkuRestrictionsType": { + "type": "string", + "description": "The type of restrictions.", + "enum": [ + "Location", + "Zone" + ], + "x-ms-enum": { + "name": "ApiManagementSkuRestrictionsType", + "modelAsString": false + } + }, + "ApiManagementSkuZoneDetails": { + "type": "object", + "description": "Describes The zonal capabilities of a SKU.", + "properties": { + "name": { + "type": "array", + "description": "The set of zones that the SKU is available in with the specified capabilities.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "capabilities": { + "type": "array", + "description": "A list of capabilities that are available for the SKU in the specified list of zones.", + "items": { + "$ref": "#/definitions/ApiManagementSkuCapabilities" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ApiManagementSkusResult": { + "type": "object", + "description": "The List Resource Skus operation response.", + "properties": { + "value": { + "type": "array", + "description": "The list of skus available for the subscription.", + "items": { + "$ref": "#/definitions/ApiManagementSku" + }, + "x-ms-identifiers": [ + "name", + "resourceType" + ] + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Resource Skus. Call ListNext() with this URI to fetch the next page of Resource Skus", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "ApiManagementWorkspaceLinksListResult": { + "type": "object", + "description": "The response of the List API Management WorkspaceLink operation.", + "properties": { + "value": { + "type": "array", + "description": "Result of the List API Management WorkspaceLinks operation.", + "items": { + "$ref": "#/definitions/ApiManagementWorkspaceLinksResource" + } + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." + } + }, + "required": [ + "value" + ] + }, + "ApiManagementWorkspaceLinksProperties": { + "type": "object", + "description": "Properties of an API Management workspaceLinks resource.", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceLinksBaseProperties" + } + ] + }, + "ApiManagementWorkspaceLinksResource": { + "type": "object", + "description": "A single API Management WorkspaceLinks in List or Get response.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiManagementWorkspaceLinksProperties", + "description": "Properties of the API Management WorkspaceLinks.", + "x-ms-client-flatten": true + }, + "etag": { + "$ref": "#/definitions/Azure.Core.eTag", + "description": "ETag of the resource.", + "readOnly": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ApiReleaseCollection": { + "type": "object", + "description": "Paged ApiRelease list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/ApiReleaseContract" + }, + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "ApiReleaseContract": { + "type": "object", + "description": "ApiRelease details.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiReleaseContractProperties", + "description": "ApiRelease entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ApiReleaseContractProperties": { + "type": "object", + "description": "API Release details", + "properties": { + "apiId": { + "type": "string", + "description": "Identifier of the API the release belongs to." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.", + "readOnly": true + }, + "updatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The time the API release was updated.", + "readOnly": true + }, + "notes": { + "type": "string", + "description": "Release Notes" + } + } + }, + "ApiRevisionCollection": { + "type": "object", + "description": "Paged API Revision list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/ApiRevisionContract" + }, + "readOnly": true, + "x-ms-identifiers": [ + "apiId" + ] + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "ApiRevisionContract": { + "type": "object", + "description": "Summary of revision metadata.", + "properties": { + "apiId": { + "type": "string", + "description": "Identifier of the API Revision.", + "readOnly": true + }, + "apiRevision": { + "type": "string", + "description": "Revision number of API.", + "minLength": 1, + "maxLength": 100, + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The time the API Revision was created. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.", + "readOnly": true + }, + "updatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The time the API Revision were updated. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the API Revision.", + "maxLength": 256, + "readOnly": true + }, + "privateUrl": { + "type": "string", + "description": "Gateway URL for accessing the non-current API Revision.", + "readOnly": true + }, + "isOnline": { + "type": "boolean", + "description": "Indicates if API revision is the current api revision.", + "readOnly": true + }, + "isCurrent": { + "type": "boolean", + "description": "Indicates if API revision is accessible via the gateway.", + "readOnly": true + } + } + }, + "ApiRevisionInfoContract": { + "type": "object", + "description": "Object used to create an API Revision or Version based on an existing API Revision", + "properties": { + "sourceApiId": { + "type": "string", + "description": "Resource identifier of API to be used to create the revision from." + }, + "apiVersionName": { + "type": "string", + "description": "Version identifier for the new API Version.", + "maxLength": 100 + }, + "apiRevisionDescription": { + "type": "string", + "description": "Description of new API Revision.", + "maxLength": 256 + }, + "apiVersionSet": { + "$ref": "#/definitions/ApiVersionSetContractDetails", + "description": "Version set details" + } + } + }, + "ApiTagResourceContractProperties": { + "type": "object", + "description": "API contract properties for the Tag Resources.", + "properties": { + "id": { + "type": "string", + "description": "API identifier in the form /apis/{apiId}." + }, + "name": { + "type": "string", + "description": "API name.", + "minLength": 1, + "maxLength": 300 + }, + "serviceUrl": { + "type": "string", + "description": "Absolute URL of the backend service implementing this API.", + "minLength": 1, + "maxLength": 2000 + }, + "path": { + "type": "string", + "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.", + "minLength": 0, + "maxLength": 400 + }, + "protocols": { + "type": "array", + "description": "Describes on which protocols the operations in this API can be invoked.", + "items": { + "$ref": "#/definitions/Protocol" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiEntityBaseContract" + } + ] + }, + "ApiType": { + "type": "string", + "description": "Type of API.", + "enum": [ + "http", + "soap", + "websocket", + "graphql", + "odata", + "grpc" + ], + "x-ms-enum": { + "name": "ApiType", + "modelAsString": true, + "values": [ + { + "name": "http", + "value": "http" + }, + { + "name": "soap", + "value": "soap" + }, + { + "name": "websocket", + "value": "websocket" + }, + { + "name": "graphql", + "value": "graphql" + }, + { + "name": "odata", + "value": "odata" + }, + { + "name": "grpc", + "value": "grpc" + } + ] + } + }, + "ApiUpdateContract": { + "type": "object", + "description": "API update contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiContractUpdateProperties", + "description": "Properties of the API entity that can be updated.", + "x-ms-client-flatten": true + } + } + }, + "ApiVersionConstraint": { + "type": "object", + "description": "Control Plane Apis version constraint for the API Management service.", + "properties": { + "minApiVersion": { + "type": "string", + "description": "Limit control plane API calls to API Management service with version equal to or newer than this value." + } + } + }, + "ApiVersionSetCollection": { + "type": "object", + "description": "Paged API Version Set list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/ApiVersionSetContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "ApiVersionSetContract": { + "type": "object", + "description": "API Version Set Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiVersionSetContractProperties", + "description": "API VersionSet contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ApiVersionSetContractDetails": { + "type": "object", + "description": "An API Version Set contains the common configuration for a set of API Versions relating", + "properties": { + "id": { + "type": "string", + "description": "Identifier for existing API Version Set. Omit this value to create a new Version Set." + }, + "name": { + "type": "string", + "description": "The display Name of the API Version Set." + }, + "description": { + "type": "string", + "description": "Description of API Version Set." + }, + "versioningScheme": { + "$ref": "#/definitions/VersioningScheme", + "description": "An value that determines where the API Version identifier will be located in a HTTP request." + }, + "versionQueryName": { + "type": "string", + "description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`." + }, + "versionHeaderName": { + "type": "string", + "description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`." + } + } + }, + "ApiVersionSetContractProperties": { + "type": "object", + "description": "Properties of an API Version Set.", + "properties": { + "displayName": { + "type": "string", + "description": "Name of API Version Set", + "minLength": 1, + "maxLength": 100 + }, + "versioningScheme": { + "$ref": "#/definitions/VersioningScheme", + "description": "An value that determines where the API Version identifier will be located in a HTTP request." + } + }, + "required": [ + "displayName", + "versioningScheme" + ], + "allOf": [ + { + "$ref": "#/definitions/ApiVersionSetEntityBase" + } + ] + }, + "ApiVersionSetEntityBase": { + "type": "object", + "description": "API Version set base parameters", + "properties": { + "description": { + "type": "string", + "description": "Description of API Version Set." + }, + "versionQueryName": { + "type": "string", + "description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`.", + "minLength": 1, + "maxLength": 100 + }, + "versionHeaderName": { + "type": "string", + "description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.", + "minLength": 1, + "maxLength": 100 + } + } + }, + "ApiVersionSetUpdateParameters": { + "type": "object", + "description": "Parameters to update or create an API Version Set Contract.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiVersionSetUpdateParametersProperties", + "description": "Parameters to update or create an API Version Set Contract.", + "x-ms-client-flatten": true + } + } + }, + "ApiVersionSetUpdateParametersProperties": { + "type": "object", + "description": "Properties used to create or update an API Version Set.", + "properties": { + "displayName": { + "type": "string", + "description": "Name of API Version Set", + "minLength": 1, + "maxLength": 100 + }, + "versioningScheme": { + "$ref": "#/definitions/VersioningScheme", + "description": "An value that determines where the API Version identifier will be located in a HTTP request." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiVersionSetEntityBase" + } + ] + }, + "ApimIdentityType": { + "type": "string", + "description": "The type of identity used for the resource. 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 service.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ApimIdentityType", + "modelAsString": true, + "values": [ + { + "name": "SystemAssigned", + "value": "SystemAssigned" + }, + { + "name": "UserAssigned", + "value": "UserAssigned" + }, + { + "name": "SystemAssigned, UserAssigned", + "value": "SystemAssigned, UserAssigned" + }, + { + "name": "None", + "value": "None" + } + ] + } + }, + "ApimResource": { + "type": "object", + "description": "The Resource definition.", + "properties": { + "id": { + "type": "string", + "description": "Resource ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Resource type for API Management resource is set to Microsoft.ApiManagement.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AppType": { + "type": "string", + "enum": [ + "portal", + "developerPortal" + ], + "x-ms-enum": { + "name": "AppType", + "modelAsString": true, + "values": [ + { + "name": "portal", + "value": "portal", + "description": "User create request was sent by legacy developer portal." + }, + { + "name": "developerPortal", + "value": "developerPortal", + "description": "User create request was sent by new developer portal." + } + ] + } + }, + "ArmIdWrapper": { + "type": "object", + "description": "A wrapper for an ARM resource id", + "properties": { + "id": { + "type": "string", + "readOnly": true + } + } + }, + "AssociationContract": { + "type": "object", + "description": "Association entity details.", + "properties": { + "properties": { + "$ref": "#/definitions/AssociationContractProperties", + "description": "Association entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssociationContractProperties": { + "type": "object", + "description": "Association entity contract properties.", + "properties": { + "provisioningState": { + "type": "string", + "description": "Provisioning state.", + "enum": [ + "created" + ], + "x-ms-enum": { + "modelAsString": false + } + } + } + }, + "AsyncOperationStatus": { + "type": "string", + "description": "Status of an async operation.", + "enum": [ + "Started", + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "AsyncOperationStatus", + "modelAsString": false + } + }, + "AsyncResolverStatus": { + "type": "string", + "description": "Status of an async resolver.", + "enum": [ + "Started", + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "AsyncResolverStatus", + "modelAsString": false + } + }, + "AuthenticationSettingsContract": { + "type": "object", + "description": "API Authentication Settings.", + "properties": { + "oAuth2": { + "$ref": "#/definitions/OAuth2AuthenticationSettingsContract", + "description": "OAuth2 Authentication settings" + }, + "openid": { + "$ref": "#/definitions/OpenIdAuthenticationSettingsContract", + "description": "OpenID Connect Authentication Settings" + }, + "oAuth2AuthenticationSettings": { + "type": "array", + "description": "Collection of OAuth2 authentication settings included into this API.", + "items": { + "$ref": "#/definitions/OAuth2AuthenticationSettingsContract" + }, + "x-ms-identifiers": [ + "authorizationServerId" + ] + }, + "openidAuthenticationSettings": { + "type": "array", + "description": "Collection of Open ID Connect authentication settings included into this API.", + "items": { + "$ref": "#/definitions/OpenIdAuthenticationSettingsContract" + }, + "x-ms-identifiers": [ + "openidProviderId" + ] + } + } + }, + "AuthorizationAccessPolicyCollection": { + "type": "object", + "description": "Paged Authorization Access Policy list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/AuthorizationAccessPolicyContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Paged Authorization Access Policy list representation." + } + } + }, + "AuthorizationAccessPolicyContract": { + "type": "object", + "description": "Authorization access policy contract.", + "properties": { + "properties": { + "$ref": "#/definitions/AuthorizationAccessPolicyContractProperties", + "description": "Properties of the Authorization Contract.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AuthorizationAccessPolicyContractProperties": { + "type": "object", + "description": "Authorization Access Policy details.", + "properties": { + "appIds": { + "type": "array", + "description": "The allowed Azure Active Directory Application IDs", + "items": { + "type": "string" + } + }, + "tenantId": { + "type": "string", + "description": "The Tenant Id" + }, + "objectId": { + "type": "string", + "description": "The Object Id" + } + } + }, + "AuthorizationCollection": { + "type": "object", + "description": "Paged Authorization list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/AuthorizationContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "AuthorizationConfirmConsentCodeRequestContract": { + "type": "object", + "description": "Authorization confirm consent code request contract.", + "properties": { + "consentCode": { + "type": "string", + "description": "The consent code from the authorization server after authorizing and consenting." + } + } + }, + "AuthorizationContract": { + "type": "object", + "description": "Authorization contract.", + "properties": { + "properties": { + "$ref": "#/definitions/AuthorizationContractProperties", + "description": "Properties of the Authorization Contract.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AuthorizationContractProperties": { + "type": "object", + "description": "Authorization details.", + "properties": { + "authorizationType": { + "$ref": "#/definitions/AuthorizationType", + "description": "Authorization type options", + "x-ms-client-name": "AuthorizationType" + }, + "oauth2grantType": { + "$ref": "#/definitions/OAuth2GrantType", + "description": "OAuth2 grant type options", + "x-ms-client-name": "OAuth2GrantType" + }, + "parameters": { + "type": "object", + "description": "Authorization parameters", + "additionalProperties": { + "type": "string" + } + }, + "error": { + "$ref": "#/definitions/AuthorizationError", + "description": "Authorization error details." + }, + "status": { + "type": "string", + "description": "Status of the Authorization" + } + } + }, + "AuthorizationError": { + "type": "object", + "description": "Authorization error details.", + "properties": { + "code": { + "type": "string", + "description": "Error code" + }, + "message": { + "type": "string", + "description": "Error message" + } + } + }, + "AuthorizationLoginRequestContract": { + "type": "object", + "description": "Authorization login request contract.", + "properties": { + "postLoginRedirectUrl": { + "type": "string", + "description": "The redirect URL after login has completed." + } + } + }, + "AuthorizationLoginResponseContract": { + "type": "object", + "description": "Authorization login response contract.", + "properties": { + "loginLink": { + "type": "string", + "description": "The login link" + } + } + }, + "AuthorizationMethod": { + "type": "string", + "enum": [ + "HEAD", + "OPTIONS", + "TRACE", + "GET", + "POST", + "PUT", + "PATCH", + "DELETE" + ], + "x-ms-enum": { + "name": "AuthorizationMethod", + "modelAsString": false + } + }, + "AuthorizationProviderCollection": { + "type": "object", + "description": "Paged Authorization Provider list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/AuthorizationProviderContract" + } + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "AuthorizationProviderContract": { + "type": "object", + "description": "Authorization Provider contract.", + "properties": { + "properties": { + "$ref": "#/definitions/AuthorizationProviderContractProperties", + "description": "Properties of the Authorization Provider Contract.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AuthorizationProviderContractProperties": { + "type": "object", + "description": "Authorization Provider details.", + "properties": { + "displayName": { + "type": "string", + "description": "Authorization Provider name. Must be 1 to 300 characters long.", + "minLength": 1, + "maxLength": 300 + }, + "identityProvider": { + "type": "string", + "description": "Identity provider name. Must be 1 to 300 characters long." + }, + "oauth2": { + "$ref": "#/definitions/AuthorizationProviderOAuth2Settings", + "description": "OAuth2 settings" + } + } + }, + "AuthorizationProviderOAuth2GrantTypes": { + "type": "object", + "description": "Authorization Provider oauth2 grant types settings", + "properties": { + "authorizationCode": { + "type": "object", + "description": "OAuth2 authorization code grant parameters", + "additionalProperties": { + "type": "string" + } + }, + "clientCredentials": { + "type": "object", + "description": "OAuth2 client credential grant parameters", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AuthorizationProviderOAuth2Settings": { + "type": "object", + "description": "OAuth2 settings details", + "properties": { + "redirectUrl": { + "type": "string", + "description": "Redirect URL to be set in the OAuth application." + }, + "grantTypes": { + "$ref": "#/definitions/AuthorizationProviderOAuth2GrantTypes", + "description": "OAuth2 settings" + } + } + }, + "AuthorizationServerCollection": { + "type": "object", + "description": "Paged OAuth2 Authorization Servers list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/AuthorizationServerContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "AuthorizationServerContract": { + "type": "object", + "description": "External OAuth authorization server settings.", + "properties": { + "properties": { + "$ref": "#/definitions/AuthorizationServerContractProperties", + "description": "Properties of the External OAuth authorization server Contract.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AuthorizationServerContractBaseProperties": { + "type": "object", + "description": "External OAuth authorization server Update settings contract.", + "properties": { + "description": { + "type": "string", + "description": "Description of the authorization server. Can contain HTML formatting tags." + }, + "authorizationMethods": { + "type": "array", + "description": "HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.", + "items": { + "$ref": "#/definitions/AuthorizationMethod" + } + }, + "clientAuthenticationMethod": { + "type": "array", + "description": "Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.", + "items": { + "$ref": "#/definitions/ClientAuthenticationMethod" + } + }, + "tokenBodyParameters": { + "type": "array", + "description": "Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {\"name\" : \"name value\", \"value\": \"a value\"}.", + "items": { + "$ref": "#/definitions/TokenBodyParameterContract" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "tokenEndpoint": { + "type": "string", + "description": "OAuth token endpoint. Contains absolute URI to entity being referenced." + }, + "supportState": { + "type": "boolean", + "description": "If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security." + }, + "defaultScope": { + "type": "string", + "description": "Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values." + }, + "bearerTokenSendingMethods": { + "type": "array", + "description": "Specifies the mechanism by which access token is passed to the API.", + "items": { + "$ref": "#/definitions/BearerTokenSendingMethod" + } + }, + "resourceOwnerUsername": { + "type": "string", + "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username." + }, + "resourceOwnerPassword": { + "type": "string", + "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password." + } + } + }, + "AuthorizationServerContractProperties": { + "type": "object", + "description": "External OAuth authorization server settings Properties.", + "properties": { + "displayName": { + "type": "string", + "description": "User-friendly authorization server name.", + "minLength": 1, + "maxLength": 50 + }, + "useInTestConsole": { + "type": "boolean", + "description": "If true, the authorization server may be used in the developer portal test console. True by default if no value is provided." + }, + "useInApiDocumentation": { + "type": "boolean", + "description": "If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided." + }, + "clientRegistrationEndpoint": { + "type": "string", + "description": "Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced." + }, + "authorizationEndpoint": { + "type": "string", + "description": "OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2." + }, + "grantTypes": { + "type": "array", + "description": "Form of an authorization grant, which the client uses to request the access token.", + "items": { + "$ref": "#/definitions/GrantType" + } + }, + "clientId": { + "type": "string", + "description": "Client or app id registered with this authorization server." + }, + "clientSecret": { + "type": "string", + "format": "password", + "description": "Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "x-ms-secret": true + } + }, + "required": [ + "displayName", + "clientRegistrationEndpoint", + "authorizationEndpoint", + "grantTypes", + "clientId" + ], + "allOf": [ + { + "$ref": "#/definitions/AuthorizationServerContractBaseProperties" + } + ] + }, + "AuthorizationServerSecretsContract": { + "type": "object", + "description": "OAuth Server Secrets Contract.", + "properties": { + "clientSecret": { + "type": "string", + "format": "password", + "description": "oAuth Authorization Server Secrets.", + "x-ms-secret": true + }, + "resourceOwnerUsername": { + "type": "string", + "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username." + }, + "resourceOwnerPassword": { + "type": "string", + "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password." + } + } + }, + "AuthorizationServerUpdateContract": { + "type": "object", + "description": "External OAuth authorization server settings.", + "properties": { + "properties": { + "$ref": "#/definitions/AuthorizationServerUpdateContractProperties", + "description": "Properties of the External OAuth authorization server update Contract.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AuthorizationServerUpdateContractProperties": { + "type": "object", + "description": "External OAuth authorization server Update settings contract.", + "properties": { + "displayName": { + "type": "string", + "description": "User-friendly authorization server name.", + "minLength": 1, + "maxLength": 50 + }, + "useInTestConsole": { + "type": "boolean", + "description": "If true, the authorization server may be used in the developer portal test console. True by default if no value is provided." + }, + "useInApiDocumentation": { + "type": "boolean", + "description": "If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided." + }, + "clientRegistrationEndpoint": { + "type": "string", + "description": "Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced." + }, + "authorizationEndpoint": { + "type": "string", + "description": "OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2." + }, + "grantTypes": { + "type": "array", + "description": "Form of an authorization grant, which the client uses to request the access token.", + "items": { + "$ref": "#/definitions/GrantType" + } + }, + "clientId": { + "type": "string", + "description": "Client or app id registered with this authorization server." + }, + "clientSecret": { + "type": "string", + "format": "password", + "description": "Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "x-ms-secret": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AuthorizationServerContractBaseProperties" + } + ] + }, + "AuthorizationType": { + "type": "string", + "description": "Authorization type options", + "enum": [ + "OAuth2" + ], + "x-ms-enum": { + "name": "AuthorizationType", + "modelAsString": true, + "values": [ + { + "name": "OAuth2", + "value": "OAuth2", + "description": "OAuth2 authorization type" + } + ] + } + }, + "Azure.Core.eTag": { + "type": "string", + "description": "The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.\nIt lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.\n\nIt is a string of ASCII characters placed between double quotes, like \"675af34563dc-tr34\"." + }, + "Backend-sessionId-source": { + "type": "string", + "description": "Source from where the session id is extracted.", + "enum": [ + "cookie" + ], + "x-ms-enum": { + "name": "Backend-sessionId-source", + "modelAsString": true, + "values": [ + { + "name": "cookie", + "value": "cookie", + "description": "The session id is set by APIM gateway in a cookie and is extracted from the cookies in client requests." + } + ] + } + }, + "BackendAuthorizationHeaderCredentials": { + "type": "object", + "description": "Authorization header information.", + "properties": { + "scheme": { + "type": "string", + "description": "Authentication Scheme name.", + "minLength": 1, + "maxLength": 100 + }, + "parameter": { + "type": "string", + "description": "Authentication Parameter value.", + "minLength": 1, + "maxLength": 300 + } + }, + "required": [ + "scheme", + "parameter" + ] + }, + "BackendBaseParameters": { + "type": "object", + "description": "Backend entity base Parameter set.", + "properties": { + "title": { + "type": "string", + "description": "Backend Title.", + "minLength": 1, + "maxLength": 300 + }, + "description": { + "type": "string", + "description": "Backend Description.", + "minLength": 1, + "maxLength": 2000 + }, + "resourceId": { + "type": "string", + "description": "Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.", + "minLength": 1, + "maxLength": 2000 + }, + "properties": { + "$ref": "#/definitions/BackendProperties", + "description": "Backend Properties contract" + }, + "credentials": { + "$ref": "#/definitions/BackendCredentialsContract", + "description": "Backend Credentials Contract Properties" + }, + "proxy": { + "$ref": "#/definitions/BackendProxyContract", + "description": "Backend gateway Contract Properties" + }, + "tls": { + "$ref": "#/definitions/BackendTlsProperties", + "description": "Backend TLS Properties" + }, + "circuitBreaker": { + "$ref": "#/definitions/BackendCircuitBreaker", + "description": "Backend Circuit Breaker Configuration" + }, + "pool": { + "$ref": "#/definitions/BackendBaseParametersPool", + "description": "Backend Pool Properties" + }, + "type": { + "$ref": "#/definitions/BackendType", + "description": "Type of the backend. A backend can be either Single or Pool." + } + } + }, + "BackendBaseParametersPool": { + "type": "object", + "description": "Backend Pool Properties", + "allOf": [ + { + "$ref": "#/definitions/BackendPool" + } + ] + }, + "BackendCircuitBreaker": { + "type": "object", + "description": "The configuration of the backend circuit breaker", + "properties": { + "rules": { + "type": "array", + "description": "The rules for tripping the backend.", + "items": { + "$ref": "#/definitions/CircuitBreakerRule" + }, + "x-ms-identifiers": [] + } + } + }, + "BackendCollection": { + "type": "object", + "description": "Paged Backend list representation.", + "properties": { + "value": { + "type": "array", + "description": "Backend values.", + "items": { + "$ref": "#/definitions/BackendContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "BackendConfiguration": { + "type": "object", + "description": "Information regarding how the gateway should integrate with backend systems.", + "properties": { + "subnet": { + "$ref": "#/definitions/BackendSubnetConfiguration", + "description": "The default hostname of the data-plane gateway to which requests can be sent." + } + } + }, + "BackendContract": { + "type": "object", + "description": "Backend details.", + "properties": { + "properties": { + "$ref": "#/definitions/BackendContractProperties", + "description": "Backend entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BackendContractProperties": { + "type": "object", + "description": "Parameters supplied to the Create Backend operation.", + "properties": { + "url": { + "type": "string", + "description": "Runtime Url of the Backend. Required when backend type is 'Single'.", + "minLength": 1, + "maxLength": 2000 + }, + "protocol": { + "$ref": "#/definitions/BackendProtocol", + "description": "Backend communication protocol. Required when backend type is 'Single'." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BackendBaseParameters" + } + ] + }, + "BackendCredentialsContract": { + "type": "object", + "description": "Details of the Credentials used to connect to Backend.", + "properties": { + "certificateIds": { + "type": "array", + "description": "List of Client Certificate Ids.", + "maxItems": 32, + "items": { + "type": "string" + } + }, + "certificate": { + "type": "array", + "description": "List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.", + "maxItems": 32, + "items": { + "type": "string" + } + }, + "query": { + "type": "object", + "description": "Query Parameter description.", + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "header": { + "type": "object", + "description": "Header Parameter description.", + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "authorization": { + "$ref": "#/definitions/BackendAuthorizationHeaderCredentials", + "description": "Authorization header authentication" + } + } + }, + "BackendFailureResponse": { + "type": "object", + "description": "The response to be returned when a backend fails to respond", + "properties": { + "statusCode": { + "type": "integer", + "format": "int32", + "description": "The status code of the response.", + "minimum": 100, + "maximum": 599 + } + } + }, + "BackendPool": { + "type": "object", + "description": "Backend pool information", + "properties": { + "services": { + "type": "array", + "description": "The list of backend entities belonging to a pool.", + "minItems": 1, + "items": { + "$ref": "#/definitions/BackendPoolItem" + }, + "x-ms-identifiers": [] + }, + "failureResponse": { + "$ref": "#/definitions/BackendFailureResponse", + "description": "The response to be returned when all the backends in the pool are inactive." + }, + "sessionAffinity": { + "$ref": "#/definitions/BackendSessionAffinity", + "description": "The session stickiness properties of the backend pool." + } + } + }, + "BackendPoolItem": { + "type": "object", + "description": "Backend pool service information", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity." + }, + "weight": { + "type": "integer", + "format": "int32", + "description": "The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.", + "minimum": 0, + "maximum": 100 + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.", + "minimum": 0, + "maximum": 100 + } + }, + "required": [ + "id" + ] + }, + "BackendProperties": { + "type": "object", + "description": "Properties specific to the Backend Type.", + "properties": { + "serviceFabricCluster": { + "$ref": "#/definitions/BackendServiceFabricClusterProperties", + "description": "Backend Service Fabric Cluster Properties" + } + } + }, + "BackendProtocol": { + "type": "string", + "description": "Backend communication protocol. Required when backend type is 'Single'.", + "enum": [ + "http", + "soap" + ], + "x-ms-enum": { + "name": "BackendProtocol", + "modelAsString": true, + "values": [ + { + "name": "http", + "value": "http", + "description": "The Backend is a RESTful service." + }, + { + "name": "soap", + "value": "soap", + "description": "The Backend is a SOAP service." + } + ] + } + }, + "BackendProxyContract": { + "type": "object", + "description": "Details of the Backend WebProxy Server to use in the Request to Backend.", + "properties": { + "url": { + "type": "string", + "description": "WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.", + "minLength": 1, + "maxLength": 2000 + }, + "username": { + "type": "string", + "description": "Username to connect to the WebProxy server" + }, + "password": { + "type": "string", + "description": "Password to connect to the WebProxy Server" + } + }, + "required": [ + "url" + ], + "externalDocs": { + "description": "Backend entity uses these details to connect to a WebProxy.", + "url": "https://msdn.microsoft.com/en-us/library/system.net.webproxy(v=vs.110).aspx" + } + }, + "BackendReconnectContract": { + "type": "object", + "description": "Reconnect request parameters.", + "properties": { + "properties": { + "$ref": "#/definitions/BackendReconnectProperties", + "description": "Reconnect request properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BackendReconnectProperties": { + "type": "object", + "description": "Properties to control reconnect requests.", + "properties": { + "after": { + "type": "string", + "format": "duration", + "description": "Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconnect is PT2M." + } + } + }, + "BackendServiceFabricClusterProperties": { + "type": "object", + "description": "Properties of the Service Fabric Type Backend.", + "properties": { + "clientCertificateId": { + "type": "string", + "description": "The client certificate id for the management endpoint." + }, + "clientCertificatethumbprint": { + "type": "string", + "description": "The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided" + }, + "maxPartitionResolutionRetries": { + "type": "integer", + "format": "int32", + "description": "Maximum number of retries while attempting resolve the partition." + }, + "managementEndpoints": { + "type": "array", + "description": "The cluster management endpoint.", + "items": { + "type": "string" + } + }, + "serverCertificateThumbprints": { + "type": "array", + "description": "Thumbprints of certificates cluster management service uses for tls communication", + "items": { + "type": "string" + } + }, + "serverX509Names": { + "type": "array", + "description": "Server X509 Certificate Names Collection", + "items": { + "$ref": "#/definitions/X509CertificateName" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "required": [ + "managementEndpoints" + ] + }, + "BackendSessionAffinity": { + "type": "object", + "description": "The session stickiness properties of the backend pool.", + "properties": { + "sessionId": { + "$ref": "#/definitions/BackendSessionId", + "description": "The id that identifies the requests belonging to the same session." + } + } + }, + "BackendSessionId": { + "type": "object", + "description": "The properties of the id that identifies the requests belonging to the same session.", + "properties": { + "source": { + "$ref": "#/definitions/Backend-sessionId-source", + "description": "Source from where the session id is extracted." + }, + "name": { + "type": "string", + "description": "Name of the variable that refers to the session id." + } + } + }, + "BackendSubnetConfiguration": { + "type": "object", + "description": "Information regarding how the subnet to which the gateway should be injected.", + "properties": { + "id": { + "type": "string", + "description": "The ARM ID of the subnet in which the backend systems are hosted." + } + } + }, + "BackendTlsProperties": { + "type": "object", + "description": "Properties controlling TLS Certificate Validation.", + "properties": { + "validateCertificateChain": { + "type": "boolean", + "description": "Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.", + "default": true + }, + "validateCertificateName": { + "type": "boolean", + "description": "Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.", + "default": true + } + } + }, + "BackendType": { + "type": "string", + "description": "Type of the backend. A backend can be either Single or Pool.", + "enum": [ + "Single", + "Pool" + ], + "x-ms-enum": { + "name": "BackendType", + "modelAsString": true, + "values": [ + { + "name": "Single", + "value": "Single", + "description": "supports single backend" + }, + { + "name": "Pool", + "value": "Pool", + "description": "supports pool backend" + } + ] + } + }, + "BackendUpdateParameterProperties": { + "type": "object", + "description": "Parameters supplied to the Update Backend operation.", + "properties": { + "url": { + "type": "string", + "description": "Runtime Url of the Backend. Required when backend type is 'Single'.", + "minLength": 1, + "maxLength": 2000 + }, + "protocol": { + "$ref": "#/definitions/BackendProtocol", + "description": "Backend communication protocol. Required when backend type is 'Single'." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BackendBaseParameters" + } + ] + }, + "BackendUpdateParameters": { + "type": "object", + "description": "Backend update parameters.", + "properties": { + "properties": { + "$ref": "#/definitions/BackendUpdateParameterProperties", + "description": "Backend entity update contract properties.", + "x-ms-client-flatten": true + } + } + }, + "BearerTokenSendingMethod": { + "type": "string", + "enum": [ + "authorizationHeader", + "query" + ], + "x-ms-enum": { + "name": "BearerTokenSendingMethod", + "modelAsString": true, + "values": [ + { + "name": "authorizationHeader", + "value": "authorizationHeader" + }, + { + "name": "query", + "value": "query" + } + ] + } + }, + "BearerTokenSendingMethods": { + "type": "string", + "description": "Form of an authorization grant, which the client uses to request the access token.", + "enum": [ + "authorizationHeader", + "query" + ], + "x-ms-enum": { + "name": "BearerTokenSendingMethods", + "modelAsString": true, + "values": [ + { + "name": "authorizationHeader", + "value": "authorizationHeader", + "description": "Access token will be transmitted in the Authorization header using Bearer schema" + }, + { + "name": "query", + "value": "query", + "description": "Access token will be transmitted as query parameters." + } + ] + } + }, + "BodyDiagnosticSettings": { + "type": "object", + "description": "Body logging settings.", + "properties": { + "bytes": { + "type": "integer", + "format": "int32", + "description": "Number of request body bytes to log.", + "maximum": 8192 + } + } + }, + "CacheCollection": { + "type": "object", + "description": "Paged Caches list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/CacheContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "CacheContract": { + "type": "object", + "description": "Cache details.", + "properties": { + "properties": { + "$ref": "#/definitions/CacheContractProperties", + "description": "Cache properties details.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "CacheContractProperties": { + "type": "object", + "description": "Properties of the Cache contract.", + "properties": { + "description": { + "type": "string", + "description": "Cache description", + "maxLength": 2000 + }, + "connectionString": { + "type": "string", + "description": "Runtime connection string to cache", + "maxLength": 300 + }, + "useFromLocation": { + "type": "string", + "description": "Location identifier to use cache from (should be either 'default' or valid Azure region identifier)", + "maxLength": 256 + }, + "resourceId": { + "type": "string", + "description": "Original uri of entity in external system cache points to", + "maxLength": 2000 + } + }, + "required": [ + "connectionString", + "useFromLocation" + ] + }, + "CacheUpdateParameters": { + "type": "object", + "description": "Cache update details.", + "properties": { + "properties": { + "$ref": "#/definitions/CacheUpdateProperties", + "description": "Cache update properties details.", + "x-ms-client-flatten": true + } + } + }, + "CacheUpdateProperties": { + "type": "object", + "description": "Parameters supplied to the Update Cache operation.", + "properties": { + "description": { + "type": "string", + "description": "Cache description", + "maxLength": 2000 + }, + "connectionString": { + "type": "string", + "description": "Runtime connection string to cache", + "maxLength": 300 + }, + "useFromLocation": { + "type": "string", + "description": "Location identifier to use cache from (should be either 'default' or valid Azure region identifier)", + "maxLength": 256 + }, + "resourceId": { + "type": "string", + "description": "Original uri of entity in external system cache points to", + "maxLength": 2000 + } + } + }, + "CertificateCollection": { + "type": "object", + "description": "Paged Certificates list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/CertificateContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "CertificateConfiguration": { + "type": "object", + "description": "Certificate configuration which consist of non-trusted intermediates and root certificates.", + "properties": { + "encodedCertificate": { + "type": "string", + "description": "Base64 Encoded certificate." + }, + "certificatePassword": { + "type": "string", + "description": "Certificate Password." + }, + "storeName": { + "$ref": "#/definitions/CertificateConfigurationStoreName", + "description": "The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations." + }, + "certificate": { + "$ref": "#/definitions/CertificateInformation", + "description": "Certificate information." + } + }, + "required": [ + "storeName" + ] + }, + "CertificateConfigurationStoreName": { + "type": "string", + "description": "The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.", + "enum": [ + "CertificateAuthority", + "Root" + ], + "x-ms-enum": { + "name": "CertificateConfigurationStoreName", + "modelAsString": true, + "values": [ + { + "name": "CertificateAuthority", + "value": "CertificateAuthority" + }, + { + "name": "Root", + "value": "Root" + } + ] + } + }, + "CertificateContract": { + "type": "object", + "description": "Certificate details.", + "properties": { + "properties": { + "$ref": "#/definitions/CertificateContractProperties", + "description": "Certificate properties details.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "CertificateContractProperties": { + "type": "object", + "description": "Properties of the Certificate contract.", + "properties": { + "subject": { + "type": "string", + "description": "Subject attribute of the certificate." + }, + "thumbprint": { + "type": "string", + "description": "Thumbprint of the certificate." + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "keyVault": { + "$ref": "#/definitions/KeyVaultContractProperties", + "description": "KeyVault location details of the certificate." + } + }, + "required": [ + "subject", + "thumbprint", + "expirationDate" + ] + }, + "CertificateCreateOrUpdateParameters": { + "type": "object", + "description": "Certificate create or update details.", + "properties": { + "properties": { + "$ref": "#/definitions/CertificateCreateOrUpdateProperties", + "description": "Certificate create or update properties details.", + "x-ms-client-flatten": true + } + } + }, + "CertificateCreateOrUpdateProperties": { + "type": "object", + "description": "Parameters supplied to the CreateOrUpdate certificate operation.", + "properties": { + "data": { + "type": "string", + "description": "Base 64 encoded certificate using the application/x-pkcs12 representation." + }, + "password": { + "type": "string", + "description": "Password for the Certificate" + }, + "keyVault": { + "$ref": "#/definitions/KeyVaultContractCreateProperties", + "description": "KeyVault location details of the certificate." + } + } + }, + "CertificateInformation": { + "type": "object", + "description": "SSL certificate information.", + "properties": { + "expiry": { + "type": "string", + "format": "date-time", + "description": "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "thumbprint": { + "type": "string", + "description": "Thumbprint of the certificate." + }, + "subject": { + "type": "string", + "description": "Subject of the certificate." + } + }, + "required": [ + "expiry", + "thumbprint", + "subject" + ] + }, + "CertificateSource": { + "type": "string", + "description": "Certificate Source.", + "enum": [ + "Managed", + "KeyVault", + "Custom", + "BuiltIn" + ], + "x-ms-enum": { + "name": "CertificateSource", + "modelAsString": true, + "values": [ + { + "name": "Managed", + "value": "Managed" + }, + { + "name": "KeyVault", + "value": "KeyVault" + }, + { + "name": "Custom", + "value": "Custom" + }, + { + "name": "BuiltIn", + "value": "BuiltIn" + } + ] + } + }, + "CertificateStatus": { + "type": "string", + "description": "Certificate Status.", + "enum": [ + "Completed", + "Failed", + "InProgress" + ], + "x-ms-enum": { + "name": "CertificateStatus", + "modelAsString": true, + "values": [ + { + "name": "Completed", + "value": "Completed" + }, + { + "name": "Failed", + "value": "Failed" + }, + { + "name": "InProgress", + "value": "InProgress" + } + ] + } + }, + "CircuitBreakerFailureCondition": { + "type": "object", + "description": "The trip conditions of the circuit breaker", + "properties": { + "count": { + "type": "integer", + "format": "int64", + "description": "The threshold for opening the circuit." + }, + "percentage": { + "type": "integer", + "format": "int64", + "description": "The threshold for opening the circuit." + }, + "interval": { + "type": "string", + "format": "duration", + "description": "The interval during which the failures are counted." + }, + "statusCodeRanges": { + "type": "array", + "description": "The status code ranges which are considered as failure.", + "maxItems": 10, + "items": { + "$ref": "#/definitions/FailureStatusCodeRange" + }, + "x-ms-identifiers": [] + }, + "errorReasons": { + "type": "array", + "description": "The error reasons which are considered as failure.", + "maxItems": 10, + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "CircuitBreakerRule": { + "type": "object", + "description": "Rule configuration to trip the backend.", + "properties": { + "name": { + "type": "string", + "description": "The rule name." + }, + "failureCondition": { + "$ref": "#/definitions/CircuitBreakerFailureCondition", + "description": "The conditions for tripping the circuit breaker." + }, + "tripDuration": { + "type": "string", + "format": "duration", + "description": "The duration for which the circuit will be tripped." + }, + "acceptRetryAfter": { + "type": "boolean", + "description": "flag to accept Retry-After header from the backend." + }, + "failureResponse": { + "$ref": "#/definitions/BackendFailureResponse", + "description": "The response of the backend when the circuit breaker gets open." + } + } + }, + "ClientApplicationCollection": { + "type": "object", + "description": "Paged ClientApplication list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/ClientApplicationContract" + } + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "ClientApplicationContract": { + "type": "object", + "description": "Client application details.", + "properties": { + "properties": { + "$ref": "#/definitions/ClientApplicationContractProperties", + "description": "Client application entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ClientApplicationContractProperties": { + "type": "object", + "description": "Client Application Entity Properties", + "properties": { + "displayName": { + "type": "string", + "description": "Client application name.", + "minLength": 0, + "maxLength": 300 + }, + "description": { + "type": "string", + "description": "Client application description.", + "minLength": 0, + "maxLength": 1000 + }, + "ownerId": { + "type": "string", + "description": "A resource identifier for the user who owns the application." + }, + "entraApplicationId": { + "type": "string", + "description": "Microsoft EntraID Application ID (Client ID). This is the value that is used to identify the application when it is requesting access tokens from Microsoft EntraID. This property is read-only and will be set by the system when the application is created.", + "readOnly": true + }, + "entraTenantId": { + "type": "string", + "description": "Tenant ID is a unique identifier (a GUID) for an organization directory in Microsoft’s cloud. It’s used to identify tenants across Microsoft services.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/ClientApplicationState", + "description": "Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks.", + "readOnly": true + } + }, + "required": [ + "displayName", + "ownerId" + ] + }, + "ClientApplicationProductLinkCollection": { + "type": "object", + "description": "Paged ClientApplicationProductLinkContract list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/ClientApplicationProductLinkContract" + } + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "ClientApplicationProductLinkContract": { + "type": "object", + "description": "Specifies Client Application - Product link assignment", + "properties": { + "properties": { + "$ref": "#/definitions/ClientApplicationProductLinkContractProperties", + "description": "Client application - product link entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ClientApplicationProductLinkContractProperties": { + "type": "object", + "properties": { + "productId": { + "type": "string", + "description": "The unique resource identifier of the Product." + } + }, + "required": [ + "productId" + ] + }, + "ClientApplicationSecretsContract": { + "type": "object", + "description": "Specifies client application secrets needed to authorize applications API calls", + "properties": { + "entra": { + "$ref": "#/definitions/ClientApplicationSecretsContractEntra", + "description": "Microsoft EntraID client application secrets" + } + } + }, + "ClientApplicationSecretsContractEntra": { + "type": "object", + "description": "Microsoft EntraID client application secrets", + "properties": { + "clientSecret": { + "type": "string", + "format": "password", + "description": "EntraID client application secret", + "x-ms-secret": true + }, + "expiresAt": { + "type": "string", + "format": "date-time", + "description": "EntraID client application secret expiration date.", + "readOnly": true + } + } + }, + "ClientApplicationState": { + "type": "string", + "description": "Client application state. The value derives the state of an application based on the statuses of its associated ClientApplicationProductLinks.", + "enum": [ + "pending", + "active", + "rejected", + "approved" + ], + "x-ms-enum": { + "name": "ClientApplicationState", + "modelAsString": true, + "values": [ + { + "name": "pending", + "value": "pending", + "description": "If there are no associated ClientApplicationLinks or all ClientApplicationLinks are in a state that doesn't meet the criteria for the states: active, rejected, approved (e.g., a mix of active and rejected without any approved)." + }, + { + "name": "active", + "value": "active", + "description": "If there are no approved ClientApplicationLink, but at least one ClientApplicationLink is active, the Application is considered active" + }, + { + "name": "rejected", + "value": "rejected", + "description": "If all ClientApplicationLinks are rejected, the Application is considered rejected" + }, + { + "name": "approved", + "value": "approved", + "description": "If at least one ClientApplicationLink is approved, the Application is considered approved" + } + ] + } + }, + "ClientAuthenticationMethod": { + "type": "string", + "enum": [ + "Basic", + "Body" + ], + "x-ms-enum": { + "name": "ClientAuthenticationMethod", + "modelAsString": true, + "values": [ + { + "name": "Basic", + "value": "Basic", + "description": "Basic Client Authentication method." + }, + { + "name": "Body", + "value": "Body", + "description": "Body based Authentication method." + } + ] + } + }, + "ClientSecretContract": { + "type": "object", + "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.", + "properties": { + "clientSecret": { + "type": "string", + "format": "password", + "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.", + "x-ms-secret": true + } + } + }, + "ConfigurationApi": { + "type": "object", + "description": "Information regarding the Configuration API of the API Management service.", + "properties": { + "legacyApi": { + "type": "string", + "description": "Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LegacyApiState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Legacy Configuration API (v1) is enabled for the service and self-hosted gateways can connect to it." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Legacy Configuration API (v1) is disabled for the service and self-hosted gateways can not connect to it." + } + ] + } + } + } + }, + "ConfigurationIdName": { + "type": "string", + "enum": [ + "configuration" + ], + "x-ms-enum": { + "name": "ConfigurationIdName", + "modelAsString": true, + "values": [ + { + "name": "configuration", + "value": "configuration" + } + ] + } + }, + "Confirmation": { + "type": "string", + "description": "Determines the type of confirmation e-mail that will be sent to the newly created user.", + "enum": [ + "signup", + "invite" + ], + "x-ms-enum": { + "name": "Confirmation", + "modelAsString": true, + "values": [ + { + "name": "signup", + "value": "signup", + "description": "Send an e-mail to the user confirming they have successfully signed up." + }, + { + "name": "invite", + "value": "invite", + "description": "Send an e-mail inviting the user to sign-up and complete registration." + } + ] + } + }, + "ConnectionStatus": { + "type": "string", + "description": "The connection status.", + "enum": [ + "Unknown", + "Connected", + "Disconnected", + "Degraded" + ], + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "Connected", + "value": "Connected" + }, + { + "name": "Disconnected", + "value": "Disconnected" + }, + { + "name": "Degraded", + "value": "Degraded" + } + ] + } + }, + "ConnectivityCheckProtocol": { + "type": "string", + "description": "The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value.", + "enum": [ + "TCP", + "HTTP", + "HTTPS" + ], + "x-ms-enum": { + "name": "ConnectivityCheckProtocol", + "modelAsString": true, + "values": [ + { + "name": "TCP", + "value": "TCP" + }, + { + "name": "HTTP", + "value": "HTTP" + }, + { + "name": "HTTPS", + "value": "HTTPS" + } + ] + } + }, + "ConnectivityCheckRequest": { + "type": "object", + "description": "A request to perform the connectivity check operation on a API Management service.", + "properties": { + "source": { + "$ref": "#/definitions/ConnectivityCheckRequestSource", + "description": "Definitions about the connectivity check origin." + }, + "destination": { + "$ref": "#/definitions/ConnectivityCheckRequestDestination", + "description": "The connectivity check operation destination." + }, + "preferredIPVersion": { + "$ref": "#/definitions/PreferredIPVersion", + "description": "The IP version to be used. Only IPv4 is supported for now." + }, + "protocol": { + "$ref": "#/definitions/ConnectivityCheckProtocol", + "description": "The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value." + }, + "protocolConfiguration": { + "$ref": "#/definitions/ConnectivityCheckRequestProtocolConfiguration", + "description": "Protocol-specific configuration." + } + }, + "required": [ + "source", + "destination" + ] + }, + "ConnectivityCheckRequestDestination": { + "type": "object", + "description": "The connectivity check operation destination.", + "properties": { + "address": { + "type": "string", + "description": "Destination address. Can either be an IP address or a FQDN." + }, + "port": { + "type": "integer", + "format": "int64", + "description": "Destination port." + } + }, + "required": [ + "address", + "port" + ] + }, + "ConnectivityCheckRequestProtocolConfiguration": { + "type": "object", + "description": "Protocol-specific configuration.", + "properties": { + "HTTPConfiguration": { + "$ref": "#/definitions/ConnectivityCheckRequestProtocolConfigurationHttpConfiguration", + "description": "Configuration for HTTP or HTTPS requests." + } + } + }, + "ConnectivityCheckRequestProtocolConfigurationHttpConfiguration": { + "type": "object", + "description": "Configuration for HTTP or HTTPS requests.", + "properties": { + "method": { + "$ref": "#/definitions/Method", + "description": "The HTTP method to be used." + }, + "validStatusCodes": { + "type": "array", + "description": "List of HTTP status codes considered valid for the request response.", + "items": { + "type": "integer", + "format": "int64" + } + }, + "headers": { + "type": "array", + "description": "List of headers to be included in the request.", + "items": { + "$ref": "#/definitions/HTTPHeader" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ConnectivityCheckRequestSource": { + "type": "object", + "description": "Definitions about the connectivity check origin.", + "properties": { + "region": { + "type": "string", + "description": "The API Management service region from where to start the connectivity check operation." + }, + "instance": { + "type": "integer", + "format": "int64", + "description": "The particular VMSS instance from which to fire the request." + } + }, + "required": [ + "region" + ] + }, + "ConnectivityCheckResponse": { + "type": "object", + "description": "Information on the connectivity status.", + "properties": { + "hops": { + "type": "array", + "description": "List of hops between the source and the destination.", + "items": { + "$ref": "#/definitions/ConnectivityHop" + }, + "readOnly": true + }, + "connectionStatus": { + "$ref": "#/definitions/ConnectionStatus", + "description": "The connection status.", + "readOnly": true + }, + "avgLatencyInMs": { + "type": "integer", + "format": "int64", + "description": "Average latency in milliseconds.", + "readOnly": true + }, + "minLatencyInMs": { + "type": "integer", + "format": "int64", + "description": "Minimum latency in milliseconds.", + "readOnly": true + }, + "maxLatencyInMs": { + "type": "integer", + "format": "int64", + "description": "Maximum latency in milliseconds.", + "readOnly": true + }, + "probesSent": { + "type": "integer", + "format": "int64", + "description": "Total number of probes sent.", + "readOnly": true + }, + "probesFailed": { + "type": "integer", + "format": "int64", + "description": "Number of failed probes.", + "readOnly": true + } + } + }, + "ConnectivityHop": { + "type": "object", + "description": "Information about a hop between the source and the destination.", + "properties": { + "type": { + "type": "string", + "description": "The type of the hop.", + "readOnly": true + }, + "id": { + "type": "string", + "description": "The ID of the hop.", + "readOnly": true + }, + "address": { + "type": "string", + "description": "The IP address of the hop.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "The ID of the resource corresponding to this hop.", + "readOnly": true + }, + "nextHopIds": { + "type": "array", + "description": "List of next hop identifiers.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "issues": { + "type": "array", + "description": "List of issues.", + "items": { + "$ref": "#/definitions/ConnectivityIssue" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ConnectivityIssue": { + "type": "object", + "description": "Information about an issue encountered in the process of checking for connectivity.", + "properties": { + "origin": { + "$ref": "#/definitions/Origin", + "description": "The origin of the issue.", + "readOnly": true + }, + "severity": { + "$ref": "#/definitions/Severity", + "description": "The severity of the issue.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/IssueType", + "description": "The type of issue.", + "readOnly": true + }, + "context": { + "type": "array", + "description": "Provides additional context on the issue.", + "items": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ConnectivityStatusContract": { + "type": "object", + "description": "Details about connectivity to a resource.", + "properties": { + "name": { + "type": "string", + "description": "The hostname of the resource which the service depends on. This can be the database, storage or any other azure resource on which the service depends upon.", + "minLength": 1 + }, + "status": { + "$ref": "#/definitions/ConnectivityStatusType", + "description": "Resource Connectivity Status Type identifier." + }, + "error": { + "type": "string", + "description": "Error details of the connectivity to the resource." + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "The date when the resource connectivity status was last updated. This status should be updated every 15 minutes. If this status has not been updated, then it means that the service has lost network connectivity to the resource, from inside the Virtual Network.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "lastStatusChange": { + "type": "string", + "format": "date-time", + "description": "The date when the resource connectivity status last Changed from success to failure or vice-versa. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "resourceType": { + "type": "string", + "description": "Resource Type." + }, + "isOptional": { + "type": "boolean", + "description": "Whether this is optional." + } + }, + "required": [ + "name", + "status", + "lastUpdated", + "lastStatusChange", + "resourceType", + "isOptional" + ] + }, + "ConnectivityStatusType": { + "type": "string", + "description": "Resource Connectivity Status Type identifier.", + "enum": [ + "initializing", + "success", + "failure" + ], + "x-ms-enum": { + "name": "ConnectivityStatusType", + "modelAsString": true, + "values": [ + { + "name": "initializing", + "value": "initializing" + }, + { + "name": "success", + "value": "success" + }, + { + "name": "failure", + "value": "failure" + } + ] + } + }, + "ContentFormat": { + "type": "string", + "description": "Format of the Content in which the API is getting imported. New formats can be added in the future", + "enum": [ + "wadl-xml", + "wadl-link-json", + "swagger-json", + "swagger-link-json", + "wsdl", + "wsdl-link", + "openapi", + "openapi+json", + "openapi-link", + "openapi+json-link", + "graphql-link", + "odata", + "odata-link", + "grpc", + "grpc-link" + ], + "x-ms-enum": { + "name": "ContentFormat", + "modelAsString": true, + "values": [ + { + "name": "wadl-xml", + "value": "wadl-xml", + "description": "The contents are inline and Content type is a WADL document." + }, + { + "name": "wadl-link-json", + "value": "wadl-link-json", + "description": "The WADL document is hosted on a publicly accessible internet address." + }, + { + "name": "swagger-json", + "value": "swagger-json", + "description": "The contents are inline and Content Type is a OpenAPI 2.0 JSON Document." + }, + { + "name": "swagger-link-json", + "value": "swagger-link-json", + "description": "The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address." + }, + { + "name": "wsdl", + "value": "wsdl", + "description": "The contents are inline and the document is a WSDL/Soap document." + }, + { + "name": "wsdl-link", + "value": "wsdl-link", + "description": "The WSDL document is hosted on a publicly accessible internet address." + }, + { + "name": "openapi", + "value": "openapi", + "description": "The contents are inline and Content Type is a OpenAPI 3.0 YAML Document." + }, + { + "name": "openapi+json", + "value": "openapi+json", + "description": "The contents are inline and Content Type is a OpenAPI 3.0 JSON Document." + }, + { + "name": "openapi-link", + "value": "openapi-link", + "description": "The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address." + }, + { + "name": "openapi+json-link", + "value": "openapi+json-link", + "description": "The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address." + }, + { + "name": "graphql-link", + "value": "graphql-link", + "description": "The GraphQL API endpoint hosted on a publicly accessible internet address." + }, + { + "name": "odata", + "value": "odata", + "description": "The contents are inline and Content Type is a OData XML Document." + }, + { + "name": "odata-link", + "value": "odata-link", + "description": "The OData metadata document hosted on a publicly accessible internet address." + }, + { + "name": "grpc", + "value": "grpc", + "description": "The contents are inline and Content Type is a gRPC protobuf file." + }, + { + "name": "grpc-link", + "value": "grpc-link", + "description": "The gRPC protobuf file is hosted on a publicly accessible internet address." + } + ] + } + }, + "ContentItemCollection": { + "type": "object", + "description": "Paged list of content items.", + "properties": { + "value": { + "type": "array", + "description": "Collection of content items.", + "items": { + "$ref": "#/definitions/ContentItemContract" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "ContentItemContract": { + "type": "object", + "description": "Content type contract details.", + "properties": { + "properties": { + "type": "object", + "description": "Properties of the content item.", + "additionalProperties": {}, + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ContentTypeCollection": { + "type": "object", + "description": "Paged list of content types.", + "properties": { + "value": { + "type": "array", + "description": "Collection of content items.", + "items": { + "$ref": "#/definitions/ContentTypeContract" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link, if any.", + "readOnly": true + } + } + }, + "ContentTypeContract": { + "type": "object", + "description": "Content type contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/ContentTypeContractProperties", + "description": "Properties of the content type.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ContentTypeContractProperties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Content type identifier" + }, + "name": { + "type": "string", + "description": "Content type name. Must be 1 to 250 characters long." + }, + "description": { + "type": "string", + "description": "Content type description." + }, + "schema": { + "description": "Content type schema." + }, + "version": { + "type": "string", + "description": "Content type version." + } + } + }, + "CreatedByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "CreatedByType", + "modelAsString": true, + "values": [ + { + "name": "User", + "value": "User" + }, + { + "name": "Application", + "value": "Application" + }, + { + "name": "ManagedIdentity", + "value": "ManagedIdentity" + }, + { + "name": "Key", + "value": "Key" + } + ] + } + }, + "DataMasking": { + "type": "object", + "properties": { + "queryParams": { + "type": "array", + "description": "Masking settings for Url query parameters", + "items": { + "$ref": "#/definitions/DataMaskingEntity" + }, + "x-ms-identifiers": [] + }, + "headers": { + "type": "array", + "description": "Masking settings for headers", + "items": { + "$ref": "#/definitions/DataMaskingEntity" + }, + "x-ms-identifiers": [] + } + } + }, + "DataMaskingEntity": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The name of an entity to mask (e.g. a name of a header or a query parameter)." + }, + "mode": { + "$ref": "#/definitions/DataMaskingMode", + "description": "Data masking mode." + } + } + }, + "DataMaskingMode": { + "type": "string", + "description": "Data masking mode.", + "enum": [ + "Mask", + "Hide" + ], + "x-ms-enum": { + "name": "DataMaskingMode", + "modelAsString": true, + "values": [ + { + "name": "Mask", + "value": "Mask", + "description": "Mask the value of an entity." + }, + { + "name": "Hide", + "value": "Hide", + "description": "Hide the presence of an entity." + } + ] + } + }, + "DeletedServiceContract": { + "type": "object", + "description": "Deleted API Management Service information.", + "properties": { + "properties": { + "$ref": "#/definitions/DeletedServiceContractProperties", + "description": "Deleted API Management Service details.", + "x-ms-client-flatten": true + }, + "location": { + "type": "string", + "description": "API Management Service Master Location.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DeletedServiceContractProperties": { + "type": "object", + "properties": { + "serviceId": { + "type": "string", + "description": "Fully-qualified API Management Service Resource ID" + }, + "scheduledPurgeDate": { + "type": "string", + "format": "date-time", + "description": "UTC Date and Time when the service will be automatically purged. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." + }, + "deletionDate": { + "type": "string", + "format": "date-time", + "description": "UTC Timestamp when the service was soft-deleted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." + } + } + }, + "DeletedServicesCollection": { + "type": "object", + "description": "Paged deleted API Management Services List Representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/DeletedServiceContract" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "DeployConfigurationParameterProperties": { + "type": "object", + "description": "Parameters supplied to the Deploy Configuration operation.", + "properties": { + "branch": { + "type": "string", + "description": "The name of the Git branch from which the configuration is to be deployed to the configuration database." + }, + "force": { + "type": "boolean", + "description": "The value enforcing deleting subscriptions to products that are deleted in this update." + } + }, + "required": [ + "branch" + ] + }, + "DeployConfigurationParameters": { + "type": "object", + "description": "Deploy Tenant Configuration Contract.", + "properties": { + "properties": { + "$ref": "#/definitions/DeployConfigurationParameterProperties", + "description": "Deploy Configuration Parameter contract properties.", + "x-ms-client-flatten": true + } + } + }, + "DeveloperPortalStatus": { + "type": "string", + "description": "Status of developer portal in this API Management service.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DeveloperPortalStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Developer Portal is enabled for the service." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Developer Portal is disabled for the service." + } + ] + } + }, + "DiagnosticCollection": { + "type": "object", + "description": "Paged Diagnostic list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/DiagnosticContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "DiagnosticContract": { + "type": "object", + "description": "Diagnostic details.", + "properties": { + "properties": { + "$ref": "#/definitions/DiagnosticContractProperties", + "description": "Diagnostic entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DiagnosticContractProperties": { + "type": "object", + "description": "Diagnostic Entity Properties", + "properties": { + "alwaysLog": { + "$ref": "#/definitions/AlwaysLog", + "description": "Specifies for what type of messages sampling settings should not apply." + }, + "loggerId": { + "type": "string", + "description": "Resource Id of a target logger." + }, + "sampling": { + "$ref": "#/definitions/SamplingSettings", + "description": "Sampling settings for Diagnostic." + }, + "frontend": { + "$ref": "#/definitions/PipelineDiagnosticSettings", + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." + }, + "backend": { + "$ref": "#/definitions/PipelineDiagnosticSettings", + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Backend" + }, + "largeLanguageModel": { + "$ref": "#/definitions/LLMDiagnosticSettings", + "description": "Large Language Models diagnostic settings" + }, + "logClientIp": { + "type": "boolean", + "description": "Log the ClientIP. Default is false." + }, + "httpCorrelationProtocol": { + "$ref": "#/definitions/HttpCorrelationProtocol", + "description": "Sets correlation protocol to use for Application Insights diagnostics." + }, + "verbosity": { + "$ref": "#/definitions/Verbosity", + "description": "The verbosity level applied to traces emitted by trace policies." + }, + "operationNameFormat": { + "$ref": "#/definitions/OperationNameFormat", + "description": "The format of the Operation Name for Application Insights telemetries. Default is Name." + }, + "metrics": { + "type": "boolean", + "description": "Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings." + } + }, + "required": [ + "loggerId" + ] + }, + "DiagnosticContractUpdateProperties": { + "type": "object", + "description": "Diagnostic Entity Properties", + "properties": { + "alwaysLog": { + "$ref": "#/definitions/AlwaysLog", + "description": "Specifies for what type of messages sampling settings should not apply." + }, + "loggerId": { + "type": "string", + "description": "Resource Id of a target logger." + }, + "sampling": { + "$ref": "#/definitions/SamplingSettings", + "description": "Sampling settings for Diagnostic." + }, + "frontend": { + "$ref": "#/definitions/PipelineDiagnosticSettings", + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." + }, + "backend": { + "$ref": "#/definitions/PipelineDiagnosticSettings", + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Backend" + }, + "logClientIp": { + "type": "boolean", + "description": "Log the ClientIP. Default is false." + }, + "httpCorrelationProtocol": { + "$ref": "#/definitions/HttpCorrelationProtocol", + "description": "Sets correlation protocol to use for Application Insights diagnostics." + }, + "verbosity": { + "$ref": "#/definitions/Verbosity", + "description": "The verbosity level applied to traces emitted by trace policies." + }, + "operationNameFormat": { + "$ref": "#/definitions/OperationNameFormat", + "description": "The format of the Operation Name for Application Insights telemetries. Default is Name." + }, + "metrics": { + "type": "boolean", + "description": "Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings." + } + } + }, + "DiagnosticUpdateContract": { + "type": "object", + "description": "Diagnostic details.", + "properties": { + "properties": { + "$ref": "#/definitions/DiagnosticContractUpdateProperties", + "description": "Diagnostic entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DocumentationCollection": { + "type": "object", + "description": "Paged Documentation list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/DocumentationContract" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "DocumentationContract": { + "type": "object", + "description": "Markdown documentation details.", + "properties": { + "properties": { + "$ref": "#/definitions/DocumentationContractProperties", + "description": "Markdown Documentation details.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DocumentationContractProperties": { + "type": "object", + "description": "Markdown documentation details.", + "properties": { + "title": { + "type": "string", + "description": "documentation title." + }, + "content": { + "type": "string", + "description": "Markdown documentation content." + } + } + }, + "DocumentationUpdateContract": { + "type": "object", + "description": "Documentation update contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/DocumentationContractProperties", + "description": "Markdown Documentation details.", + "x-ms-client-flatten": true + } + } + }, + "EmailTemplateCollection": { + "type": "object", + "description": "Paged email template list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/EmailTemplateContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "EmailTemplateContract": { + "type": "object", + "description": "Email Template details.", + "properties": { + "properties": { + "$ref": "#/definitions/EmailTemplateContractProperties", + "description": "Email Template entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EmailTemplateContractProperties": { + "type": "object", + "description": "Email Template Contract properties.", + "properties": { + "subject": { + "type": "string", + "description": "Subject of the Template.", + "minLength": 1, + "maxLength": 1000 + }, + "body": { + "type": "string", + "description": "Email Template Body. This should be a valid XDocument", + "minLength": 1 + }, + "title": { + "type": "string", + "description": "Title of the Template." + }, + "description": { + "type": "string", + "description": "Description of the Email Template." + }, + "isDefault": { + "type": "boolean", + "description": "Whether the template is the default template provided by API Management or has been edited.", + "readOnly": true + }, + "parameters": { + "type": "array", + "description": "Email Template Parameter values.", + "items": { + "$ref": "#/definitions/EmailTemplateParametersContractProperties" + }, + "x-ms-identifiers": [ + "title" + ] + } + }, + "required": [ + "subject", + "body" + ] + }, + "EmailTemplateParametersContractProperties": { + "type": "object", + "description": "Email Template Parameter contract.", + "properties": { + "name": { + "type": "string", + "description": "Template parameter name.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-._]+$" + }, + "title": { + "type": "string", + "description": "Template parameter title.", + "minLength": 1, + "maxLength": 4096 + }, + "description": { + "type": "string", + "description": "Template parameter description.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-._]+$" + } + } + }, + "EmailTemplateUpdateParameterProperties": { + "type": "object", + "description": "Email Template Update Contract properties.", + "properties": { + "subject": { + "type": "string", + "description": "Subject of the Template.", + "minLength": 1, + "maxLength": 1000 + }, + "title": { + "type": "string", + "description": "Title of the Template." + }, + "description": { + "type": "string", + "description": "Description of the Email Template." + }, + "body": { + "type": "string", + "description": "Email Template Body. This should be a valid XDocument", + "minLength": 1 + }, + "parameters": { + "type": "array", + "description": "Email Template Parameter values.", + "items": { + "$ref": "#/definitions/EmailTemplateParametersContractProperties" + }, + "x-ms-identifiers": [ + "title" + ] + } + } + }, + "EmailTemplateUpdateParameters": { + "type": "object", + "description": "Email Template update Parameters.", + "properties": { + "properties": { + "$ref": "#/definitions/EmailTemplateUpdateParameterProperties", + "description": "Email Template Update contract properties.", + "x-ms-client-flatten": true + } + } + }, + "EndpointDependency": { + "type": "object", + "description": "A domain name that a service is reached at.", + "properties": { + "domainName": { + "type": "string", + "description": "The domain name of the dependency." + }, + "endpointDetails": { + "type": "array", + "description": "The Ports used when connecting to DomainName.", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [ + "region", + "port" + ] + } + } + }, + "EndpointDetail": { + "type": "object", + "description": "Current TCP connectivity information from the Api Management Service to a single endpoint.", + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "The port an endpoint is connected to." + }, + "region": { + "type": "string", + "description": "The region of the dependency." + } + } + }, + "ErrorFieldContract": { + "type": "object", + "description": "Error Field contract.", + "properties": { + "code": { + "type": "string", + "description": "Property level error code." + }, + "message": { + "type": "string", + "description": "Human-readable representation of property-level error." + }, + "target": { + "type": "string", + "description": "Property name." + } + } + }, + "ErrorResponseBody": { + "type": "object", + "description": "Error Body contract.", + "properties": { + "code": { + "type": "string", + "description": "Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response." + }, + "message": { + "type": "string", + "description": "Human-readable representation of the error." + }, + "details": { + "type": "array", + "description": "The list of invalid fields send in request, in case of validation error.", + "items": { + "$ref": "#/definitions/ErrorFieldContract" + }, + "x-ms-identifiers": [ + "message", + "target" + ] + } + } + }, + "ExportApi": { + "type": "string", + "enum": [ + "true" + ], + "x-ms-enum": { + "name": "ExportApi", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true" + } + ] + } + }, + "ExportFormat": { + "type": "string", + "enum": [ + "swagger-link", + "wsdl-link", + "wadl-link", + "openapi-link", + "openapi+json-link" + ], + "x-ms-enum": { + "name": "ExportFormat", + "modelAsString": true, + "values": [ + { + "name": "Swagger", + "value": "swagger-link", + "description": "Export the Api Definition in OpenAPI 2.0 Specification as JSON document to the Storage Blob." + }, + { + "name": "Wsdl", + "value": "wsdl-link", + "description": "Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`" + }, + { + "name": "Wadl", + "value": "wadl-link", + "description": "Export the Api Definition in WADL Schema to Storage Blob." + }, + { + "name": "Openapi", + "value": "openapi-link", + "description": "Export the Api Definition in OpenAPI 3.0 Specification as YAML document to Storage Blob." + }, + { + "name": "OpenapiJson", + "value": "openapi+json-link", + "description": "Export the Api Definition in OpenAPI 3.0 Specification as JSON document to Storage Blob." + } + ] + } + }, + "ExportResultFormat": { + "type": "string", + "description": "Format in which the API Details are exported to the Storage Blob with Sas Key valid for 5 minutes.", + "enum": [ + "swagger-link-json", + "wadl-link-json", + "wsdl-link+xml", + "openapi-link" + ], + "x-ms-enum": { + "name": "ExportResultFormat", + "modelAsString": true, + "values": [ + { + "name": "Swagger", + "value": "swagger-link-json", + "description": "The API Definition is exported in OpenAPI Specification 2.0 format to the Storage Blob." + }, + { + "name": "Wadl", + "value": "wadl-link-json", + "description": "Export the API Definition in WADL Schema to Storage Blob." + }, + { + "name": "Wsdl", + "value": "wsdl-link+xml", + "description": "The API Definition is exported in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`" + }, + { + "name": "OpenApi", + "value": "openapi-link", + "description": "Export the API Definition in OpenAPI Specification 3.0 to Storage Blob." + } + ] + } + }, + "FailureStatusCodeRange": { + "type": "object", + "description": "The failure http status code range", + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum http status code.", + "minimum": 200, + "maximum": 599 + }, + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum http status code.", + "minimum": 200, + "maximum": 599 + } + } + }, + "FrontendConfiguration": { + "type": "object", + "description": "Information regarding how the gateway should be exposed.", + "properties": { + "defaultHostname": { + "type": "string", + "description": "The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.", + "readOnly": true + } + } + }, + "GatewayCertificateAuthorityCollection": { + "type": "object", + "description": "Paged Gateway certificate authority list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/GatewayCertificateAuthorityContract" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "GatewayCertificateAuthorityContract": { + "type": "object", + "description": "Gateway certificate authority details.", + "properties": { + "properties": { + "$ref": "#/definitions/GatewayCertificateAuthorityContractProperties", + "description": "Gateway certificate authority details.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GatewayCertificateAuthorityContractProperties": { + "type": "object", + "description": "Gateway certificate authority details.", + "properties": { + "isTrusted": { + "type": "boolean", + "description": "Determines whether certificate authority is trusted." + } + } + }, + "GatewayCollection": { + "type": "object", + "description": "Paged Gateway list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/GatewayContract" + }, + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "GatewayConfigConnectionBaseProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "The current provisioning state of the API Management gateway config connection", + "readOnly": true + }, + "sourceId": { + "type": "string", + "format": "arm-id", + "description": "The link to the API Management service workspace.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ApiManagement/service/workspaces" + } + ] + } + }, + "defaultHostname": { + "type": "string", + "description": "The default hostname of the data-plane gateway.", + "readOnly": true + }, + "hostnames": { + "type": "array", + "description": "The hostnames of the data-plane gateway to which requests can be sent.", + "items": { + "type": "string" + } + } + } + }, + "GatewayConfigurationApi": { + "type": "object", + "description": "Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.", + "properties": { + "hostname": { + "type": "string", + "description": "Hostname to which the agent connects to propagate configuration to the cloud.", + "readOnly": true + } + } + }, + "GatewayContract": { + "type": "object", + "description": "Gateway details.", + "properties": { + "properties": { + "$ref": "#/definitions/GatewayContractProperties", + "description": "Gateway details.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GatewayContractProperties": { + "type": "object", + "description": "Properties of the Gateway contract.", + "properties": { + "locationData": { + "$ref": "#/definitions/ResourceLocationDataContract", + "description": "Gateway location." + }, + "description": { + "type": "string", + "description": "Gateway description", + "maxLength": 1000 + } + } + }, + "GatewayDebugCredentialsContract": { + "type": "object", + "description": "Gateway debug credentials.", + "properties": { + "token": { + "type": "string", + "format": "password", + "description": "Gateway debug token.", + "x-ms-secret": true + } + } + }, + "GatewayHostnameConfigurationCollection": { + "type": "object", + "description": "Paged Gateway hostname configuration list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/GatewayHostnameConfigurationContract" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "GatewayHostnameConfigurationContract": { + "type": "object", + "description": "Gateway hostname configuration details.", + "properties": { + "properties": { + "$ref": "#/definitions/GatewayHostnameConfigurationContractProperties", + "description": "Gateway hostname configuration details.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GatewayHostnameConfigurationContractProperties": { + "type": "object", + "description": "Gateway hostname configuration details.", + "properties": { + "hostname": { + "type": "string", + "description": "Hostname value. Supports valid domain name, partial or full wildcard" + }, + "certificateId": { + "type": "string", + "description": "Identifier of Certificate entity that will be used for TLS connection establishment" + }, + "negotiateClientCertificate": { + "type": "boolean", + "description": "Determines whether gateway requests client certificate" + }, + "tls10Enabled": { + "type": "boolean", + "description": "Specifies if TLS 1.0 is supported" + }, + "tls11Enabled": { + "type": "boolean", + "description": "Specifies if TLS 1.1 is supported" + }, + "http2Enabled": { + "type": "boolean", + "description": "Specifies if HTTP/2.0 is supported" + } + } + }, + "GatewayKeyRegenerationRequestContract": { + "type": "object", + "description": "Gateway key regeneration request contract properties.", + "properties": { + "keyType": { + "$ref": "#/definitions/KeyType", + "description": "The Key being regenerated." + } + }, + "required": [ + "keyType" + ] + }, + "GatewayKeysContract": { + "type": "object", + "description": "Gateway authentication keys.", + "properties": { + "primary": { + "type": "string", + "description": "Primary gateway key." + }, + "secondary": { + "type": "string", + "description": "Secondary gateway key." + } + } + }, + "GatewayListDebugCredentialsContract": { + "type": "object", + "description": "List debug credentials properties.", + "properties": { + "credentialsExpireAfter": { + "type": "string", + "format": "duration", + "description": "Credentials expiration in ISO8601 format. Maximum duration of the credentials is PT1H. When property is not specified, them value PT1H is used." + }, + "purposes": { + "type": "array", + "description": "Purposes of debug credential.", + "items": { + "$ref": "#/definitions/GatewayListDebugCredentialsContractPurpose" + } + }, + "apiId": { + "type": "string", + "format": "arm-id", + "description": "Full resource Id of an API.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ApiManagement/service/apis" + }, + { + "type": "Microsoft.ApiManagement/service/workspaces/apis" + } + ] + } + } + }, + "required": [ + "purposes", + "apiId" + ] + }, + "GatewayListDebugCredentialsContractPurpose": { + "type": "string", + "description": "Purpose of debug credential.", + "enum": [ + "tracing" + ], + "x-ms-enum": { + "name": "GatewayListDebugCredentialsContractPurpose", + "modelAsString": true, + "values": [ + { + "name": "tracing", + "value": "tracing", + "description": "The tracing purpose." + } + ] + } + }, + "GatewayListTraceContract": { + "type": "object", + "description": "List trace properties.", + "properties": { + "traceId": { + "type": "string", + "description": "Trace id." + } + } + }, + "GatewayResourceSkuResult": { + "type": "object", + "description": "Describes an available API Management gateway SKU.", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource the SKU applies to.", + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/GatewaySku", + "description": "Specifies API Management gateway SKU.", + "readOnly": true + }, + "capacity": { + "$ref": "#/definitions/GatewaySkuCapacity", + "description": "Specifies the number of API Management gateway units.", + "readOnly": true + } + } + }, + "GatewayResourceSkuResults": { + "type": "object", + "description": "The API Management gateway SKUs operation response.", + "properties": { + "value": { + "type": "array", + "description": "The list of skus available for the gateway.", + "items": { + "$ref": "#/definitions/GatewayResourceSkuResult" + }, + "x-ms-identifiers": [ + "resourceType", + "sku/name" + ] + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of API Management gateway Skus." + } + }, + "required": [ + "value" + ] + }, + "GatewaySku": { + "type": "object", + "description": "Describes an available API Management SKU for gateways.", + "properties": { + "name": { + "$ref": "#/definitions/ApiGatewaySkuType", + "description": "Name of the Sku." + } + } + }, + "GatewaySkuCapacity": { + "type": "object", + "description": "Describes scaling information of a SKU.", + "properties": { + "minimum": { + "type": "integer", + "format": "int32", + "description": "The minimum capacity.", + "readOnly": true + }, + "maximum": { + "type": "integer", + "format": "int32", + "description": "The maximum capacity that can be set.", + "readOnly": true + }, + "default": { + "type": "integer", + "format": "int32", + "description": "The default capacity.", + "readOnly": true + }, + "scaleType": { + "$ref": "#/definitions/GatewaySkuCapacityScaleType", + "description": "The scale type applicable to the sku.", + "readOnly": true + } + } + }, + "GatewaySkuCapacityScaleType": { + "type": "string", + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "x-ms-enum": { + "name": "GatewaySkuCapacityScaleType", + "modelAsString": true, + "values": [ + { + "name": "Automatic", + "value": "Automatic", + "description": "Supported scale type automatic." + }, + { + "name": "Manual", + "value": "Manual", + "description": "Supported scale type manual." + }, + { + "name": "None", + "value": "None", + "description": "Scaling not supported." + } + ] + } + }, + "GatewayTokenContract": { + "type": "object", + "description": "Gateway access token.", + "properties": { + "value": { + "type": "string", + "description": "Shared Access Authentication token value for the Gateway." + } + } + }, + "GatewayTokenRequestContract": { + "type": "object", + "description": "Gateway token request contract properties.", + "properties": { + "keyType": { + "type": "string", + "description": "The Key to be used to generate gateway token.", + "default": "primary", + "enum": [ + "primary", + "secondary" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "expiry": { + "type": "string", + "format": "date-time", + "description": "The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + } + }, + "required": [ + "keyType", + "expiry" + ] + }, + "GatewayTraceContract": { + "type": "object", + "description": "Trace collected in gateway.", + "additionalProperties": {} + }, + "GenerateSsoUrlResult": { + "type": "object", + "description": "Generate SSO Url operations response details.", + "properties": { + "value": { + "type": "string", + "description": "Redirect Url containing the SSO URL value." + } + } + }, + "GlobalSchemaCollection": { + "type": "object", + "description": "The response of the list schema operation.", + "properties": { + "value": { + "type": "array", + "description": "Global Schema Contract value.", + "items": { + "$ref": "#/definitions/GlobalSchemaContract" + }, + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "GlobalSchemaContract": { + "type": "object", + "description": "Global Schema Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/GlobalSchemaContractProperties", + "description": "Properties of the Global Schema.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GlobalSchemaContractProperties": { + "type": "object", + "description": "Schema create or update contract Properties.", + "properties": { + "schemaType": { + "$ref": "#/definitions/SchemaType", + "description": "Schema Type. Immutable.", + "x-ms-client-name": "SchemaType" + }, + "description": { + "type": "string", + "description": "Free-form schema entity description." + }, + "value": { + "description": "Json-encoded string for non json-based schema." + }, + "document": { + "description": "Global Schema document object for json-based schema formats(e.g. json schema).", + "x-ms-client-flatten": true + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state", + "readOnly": true + } + }, + "required": [ + "schemaType" + ] + }, + "GrantType": { + "type": "string", + "enum": [ + "authorizationCode", + "implicit", + "resourceOwnerPassword", + "clientCredentials" + ], + "x-ms-enum": { + "name": "GrantType", + "modelAsString": true, + "values": [ + { + "name": "authorizationCode", + "value": "authorizationCode", + "description": "Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1." + }, + { + "name": "implicit", + "value": "implicit", + "description": "Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2." + }, + { + "name": "resourceOwnerPassword", + "value": "resourceOwnerPassword", + "description": "Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3." + }, + { + "name": "clientCredentials", + "value": "clientCredentials", + "description": "Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4." + } + ] + } + }, + "GroupCollection": { + "type": "object", + "description": "Paged Group list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/GroupContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "GroupContract": { + "type": "object", + "description": "Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/GroupContractProperties", + "description": "Group entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GroupContractProperties": { + "type": "object", + "description": "Group contract Properties.", + "properties": { + "displayName": { + "type": "string", + "description": "Group name.", + "minLength": 1, + "maxLength": 300 + }, + "description": { + "type": "string", + "description": "Group description. Can contain HTML formatting tags.", + "maxLength": 1000 + }, + "builtIn": { + "type": "boolean", + "description": "true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/GroupType", + "description": "Group type." + }, + "externalId": { + "type": "string", + "description": "For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null." + } + }, + "required": [ + "displayName" + ] + }, + "GroupCreateParameters": { + "type": "object", + "description": "Parameters supplied to the Create Group operation.", + "properties": { + "properties": { + "$ref": "#/definitions/GroupCreateParametersProperties", + "description": "Properties supplied to Create Group operation.", + "x-ms-client-flatten": true + } + } + }, + "GroupCreateParametersProperties": { + "type": "object", + "description": "Parameters supplied to the Create Group operation.", + "properties": { + "displayName": { + "type": "string", + "description": "Group name.", + "minLength": 1, + "maxLength": 300 + }, + "description": { + "type": "string", + "description": "Group description." + }, + "type": { + "$ref": "#/definitions/GroupType", + "description": "Group type." + }, + "externalId": { + "type": "string", + "description": "Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null." + } + }, + "required": [ + "displayName" + ] + }, + "GroupType": { + "type": "string", + "description": "Group type.", + "enum": [ + "custom", + "system", + "external" + ], + "x-ms-enum": { + "name": "GroupType", + "modelAsString": false + } + }, + "GroupUpdateParameters": { + "type": "object", + "description": "Parameters supplied to the Update Group operation.", + "properties": { + "properties": { + "$ref": "#/definitions/GroupUpdateParametersProperties", + "description": "Group entity update contract properties.", + "x-ms-client-flatten": true + } + } + }, + "GroupUpdateParametersProperties": { + "type": "object", + "description": "Parameters supplied to the Update Group operation.", + "properties": { + "displayName": { + "type": "string", + "description": "Group name.", + "minLength": 1, + "maxLength": 300 + }, + "description": { + "type": "string", + "description": "Group description." + }, + "type": { + "$ref": "#/definitions/GroupType", + "description": "Group type." + }, + "externalId": { + "type": "string", + "description": "Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null." + } + } + }, + "HTTPHeader": { + "type": "object", + "description": "HTTP header and it's value.", + "properties": { + "name": { + "type": "string", + "description": "Header name." + }, + "value": { + "type": "string", + "description": "Header value." + } + }, + "required": [ + "name", + "value" + ] + }, + "HostnameConfiguration": { + "type": "object", + "description": "Custom hostname configuration.", + "properties": { + "type": { + "$ref": "#/definitions/HostnameType", + "description": "Hostname type." + }, + "hostName": { + "type": "string", + "description": "Hostname to configure on the Api Management service." + }, + "keyVaultId": { + "type": "string", + "description": "Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type *application/x-pkcs12*" + }, + "identityClientId": { + "type": "string", + "description": "System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate." + }, + "encodedCertificate": { + "type": "string", + "description": "Base64 Encoded certificate." + }, + "certificatePassword": { + "type": "string", + "description": "Certificate Password." + }, + "defaultSslBinding": { + "type": "boolean", + "description": "Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.", + "default": false + }, + "negotiateClientCertificate": { + "type": "boolean", + "description": "Specify true to always negotiate client certificate on the hostname. Default Value is false.", + "default": false + }, + "certificate": { + "$ref": "#/definitions/CertificateInformation", + "description": "Certificate information." + }, + "certificateSource": { + "$ref": "#/definitions/CertificateSource", + "description": "Certificate Source." + }, + "certificateStatus": { + "$ref": "#/definitions/CertificateStatus", + "description": "Certificate Status." + } + }, + "required": [ + "type", + "hostName" + ] + }, + "HostnameType": { + "type": "string", + "description": "Hostname type.", + "enum": [ + "Proxy", + "Portal", + "Management", + "Scm", + "DeveloperPortal", + "ConfigurationApi" + ], + "x-ms-enum": { + "name": "HostnameType", + "modelAsString": true, + "values": [ + { + "name": "Proxy", + "value": "Proxy" + }, + { + "name": "Portal", + "value": "Portal" + }, + { + "name": "Management", + "value": "Management" + }, + { + "name": "Scm", + "value": "Scm" + }, + { + "name": "DeveloperPortal", + "value": "DeveloperPortal" + }, + { + "name": "ConfigurationApi", + "value": "ConfigurationApi" + } + ] + } + }, + "HttpCorrelationProtocol": { + "type": "string", + "description": "Sets correlation protocol to use for Application Insights diagnostics.", + "enum": [ + "None", + "Legacy", + "W3C" + ], + "x-ms-enum": { + "name": "HttpCorrelationProtocol", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Do not read and inject correlation headers." + }, + { + "name": "Legacy", + "value": "Legacy", + "description": "Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md." + }, + { + "name": "W3C", + "value": "W3C", + "description": "Inject Trace Context headers. See https://w3c.github.io/trace-context." + } + ] + } + }, + "HttpMessageDiagnostic": { + "type": "object", + "description": "Http message diagnostic settings.", + "properties": { + "headers": { + "type": "array", + "description": "Array of HTTP Headers to log.", + "items": { + "type": "string" + } + }, + "body": { + "$ref": "#/definitions/BodyDiagnosticSettings", + "description": "Body logging settings." + }, + "dataMasking": { + "$ref": "#/definitions/DataMasking", + "description": "Data masking settings." + } + } + }, + "IdentityProviderBaseParameters": { + "type": "object", + "description": "Identity Provider Base Parameter Properties.", + "properties": { + "type": { + "$ref": "#/definitions/IdentityProviderType", + "description": "Identity Provider Type identifier." + }, + "signinTenant": { + "type": "string", + "description": "The TenantId to use instead of Common when logging into Active Directory" + }, + "allowedTenants": { + "type": "array", + "description": "List of Allowed Tenants when configuring Azure Active Directory login.", + "maxItems": 32, + "items": { + "type": "string" + } + }, + "authority": { + "type": "string", + "description": "OpenID Connect discovery endpoint hostname for AAD or AAD B2C." + }, + "signupPolicyName": { + "type": "string", + "description": "Signup Policy Name. Only applies to AAD B2C Identity Provider.", + "minLength": 1 + }, + "signinPolicyName": { + "type": "string", + "description": "Signin Policy Name. Only applies to AAD B2C Identity Provider.", + "minLength": 1 + }, + "profileEditingPolicyName": { + "type": "string", + "description": "Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.", + "minLength": 1 + }, + "passwordResetPolicyName": { + "type": "string", + "description": "Password Reset Policy Name. Only applies to AAD B2C Identity Provider.", + "minLength": 1 + }, + "clientLibrary": { + "type": "string", + "description": "The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.", + "minLength": 0, + "maxLength": 16 + } + } + }, + "IdentityProviderContract": { + "type": "object", + "description": "Identity Provider details.", + "properties": { + "properties": { + "$ref": "#/definitions/IdentityProviderContractProperties", + "description": "Identity Provider contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "IdentityProviderContractProperties": { + "type": "object", + "description": "The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.", + "properties": { + "clientId": { + "type": "string", + "description": "Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.", + "minLength": 1 + }, + "clientSecret": { + "type": "string", + "format": "password", + "description": "Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "minLength": 1, + "x-ms-secret": true + }, + "certificateId": { + "type": "string", + "format": "arm-id", + "description": "Certificate full resource ID used in external Identity Provider", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ApiManagement/service/certificates" + } + ] + } + } + }, + "required": [ + "clientId" + ], + "allOf": [ + { + "$ref": "#/definitions/IdentityProviderBaseParameters" + } + ] + }, + "IdentityProviderCreateContract": { + "type": "object", + "description": "Identity Provider details.", + "properties": { + "properties": { + "$ref": "#/definitions/IdentityProviderCreateContractProperties", + "description": "Identity Provider contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "IdentityProviderCreateContractProperties": { + "type": "object", + "description": "The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.", + "properties": { + "clientId": { + "type": "string", + "description": "Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.", + "minLength": 1 + }, + "clientSecret": { + "type": "string", + "format": "password", + "description": "Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "minLength": 1, + "x-ms-secret": true + }, + "certificateId": { + "type": "string", + "format": "arm-id", + "description": "Certificate full resource ID used in external Identity Provider", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ApiManagement/service/certificates" + } + ] + } + } + }, + "required": [ + "clientId", + "clientSecret" + ], + "allOf": [ + { + "$ref": "#/definitions/IdentityProviderBaseParameters" + } + ] + }, + "IdentityProviderList": { + "type": "object", + "description": "List of all the Identity Providers configured on the service instance.", + "properties": { + "value": { + "type": "array", + "description": "Identity Provider configuration values.", + "items": { + "$ref": "#/definitions/IdentityProviderContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "IdentityProviderType": { + "type": "string", + "enum": [ + "facebook", + "google", + "microsoft", + "twitter", + "aad", + "aadB2C" + ], + "x-ms-enum": { + "name": "IdentityProviderType", + "modelAsString": true, + "values": [ + { + "name": "facebook", + "value": "facebook", + "description": "Facebook as Identity provider." + }, + { + "name": "google", + "value": "google", + "description": "Google as Identity provider." + }, + { + "name": "microsoft", + "value": "microsoft", + "description": "Microsoft Live as Identity provider." + }, + { + "name": "twitter", + "value": "twitter", + "description": "Twitter as Identity provider." + }, + { + "name": "aad", + "value": "aad", + "description": "Azure Active Directory as Identity provider." + }, + { + "name": "aadB2C", + "value": "aadB2C", + "description": "Azure Active Directory B2C as Identity provider." + } + ] + } + }, + "IdentityProviderUpdateParameters": { + "type": "object", + "description": "Parameters supplied to update Identity Provider", + "properties": { + "properties": { + "$ref": "#/definitions/IdentityProviderUpdateProperties", + "description": "Identity Provider update properties.", + "x-ms-client-flatten": true + } + } + }, + "IdentityProviderUpdateProperties": { + "type": "object", + "description": "Parameters supplied to the Update Identity Provider operation.", + "properties": { + "clientId": { + "type": "string", + "description": "Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.", + "minLength": 1 + }, + "clientSecret": { + "type": "string", + "format": "password", + "description": "Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.", + "minLength": 1, + "x-ms-secret": true + }, + "certificateId": { + "type": "string", + "format": "arm-id", + "description": "Certificate full resource ID used in external Identity Provider", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ApiManagement/service/certificates" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/IdentityProviderBaseParameters" + } + ] + }, + "IssueAttachmentCollection": { + "type": "object", + "description": "Paged Issue Attachment list representation.", + "properties": { + "value": { + "type": "array", + "description": "Issue Attachment values.", + "items": { + "$ref": "#/definitions/IssueAttachmentContract" + }, + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "IssueAttachmentContract": { + "type": "object", + "description": "Issue Attachment Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/IssueAttachmentContractProperties", + "description": "Properties of the Issue Attachment.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "IssueAttachmentContractProperties": { + "type": "object", + "description": "Issue Attachment contract Properties.", + "properties": { + "title": { + "type": "string", + "description": "Filename by which the binary data will be saved." + }, + "contentFormat": { + "type": "string", + "description": "Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property." + }, + "content": { + "type": "string", + "description": "An HTTP link or Base64-encoded binary data." + } + }, + "required": [ + "title", + "contentFormat", + "content" + ] + }, + "IssueCollection": { + "type": "object", + "description": "Paged Issue list representation.", + "properties": { + "value": { + "type": "array", + "description": "Issue values.", + "items": { + "$ref": "#/definitions/IssueContract" + }, + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "IssueCommentCollection": { + "type": "object", + "description": "Paged Issue Comment list representation.", + "properties": { + "value": { + "type": "array", + "description": "Issue Comment values.", + "items": { + "$ref": "#/definitions/IssueCommentContract" + }, + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "IssueCommentContract": { + "type": "object", + "description": "Issue Comment Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/IssueCommentContractProperties", + "description": "Properties of the Issue Comment.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "IssueCommentContractProperties": { + "type": "object", + "description": "Issue Comment contract Properties.", + "properties": { + "text": { + "type": "string", + "description": "Comment text." + }, + "createdDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the comment was created." + }, + "userId": { + "type": "string", + "description": "A resource identifier for the user who left the comment." + } + }, + "required": [ + "text", + "userId" + ] + }, + "IssueContract": { + "type": "object", + "description": "Issue Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/IssueContractProperties", + "description": "Properties of the Issue.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "IssueContractBaseProperties": { + "type": "object", + "description": "Issue contract Base Properties.", + "properties": { + "createdDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the issue was created." + }, + "state": { + "$ref": "#/definitions/State", + "description": "Status of the issue." + }, + "apiId": { + "type": "string", + "description": "A resource identifier for the API the issue was created for." + } + } + }, + "IssueContractProperties": { + "type": "object", + "description": "Issue contract Properties.", + "properties": { + "title": { + "type": "string", + "description": "The issue title." + }, + "description": { + "type": "string", + "description": "Text describing the issue." + }, + "userId": { + "type": "string", + "description": "A resource identifier for the user created the issue." + } + }, + "required": [ + "title", + "description", + "userId" + ], + "allOf": [ + { + "$ref": "#/definitions/IssueContractBaseProperties" + } + ] + }, + "IssueType": { + "type": "string", + "description": "The type of issue.", + "enum": [ + "Unknown", + "AgentStopped", + "GuestFirewall", + "DnsResolution", + "SocketBind", + "NetworkSecurityRule", + "UserDefinedRoute", + "PortThrottled", + "Platform" + ], + "x-ms-enum": { + "name": "IssueType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "AgentStopped", + "value": "AgentStopped" + }, + { + "name": "GuestFirewall", + "value": "GuestFirewall" + }, + { + "name": "DnsResolution", + "value": "DnsResolution" + }, + { + "name": "SocketBind", + "value": "SocketBind" + }, + { + "name": "NetworkSecurityRule", + "value": "NetworkSecurityRule" + }, + { + "name": "UserDefinedRoute", + "value": "UserDefinedRoute" + }, + { + "name": "PortThrottled", + "value": "PortThrottled" + }, + { + "name": "Platform", + "value": "Platform" + } + ] + } + }, + "IssueUpdateContract": { + "type": "object", + "description": "Issue update Parameters.", + "properties": { + "properties": { + "$ref": "#/definitions/IssueUpdateContractProperties", + "description": "Issue entity Update contract properties.", + "x-ms-client-flatten": true + } + } + }, + "IssueUpdateContractProperties": { + "type": "object", + "description": "Issue contract Update Properties.", + "properties": { + "title": { + "type": "string", + "description": "The issue title." + }, + "description": { + "type": "string", + "description": "Text describing the issue." + }, + "userId": { + "type": "string", + "description": "A resource identifier for the user created the issue." + } + }, + "allOf": [ + { + "$ref": "#/definitions/IssueContractBaseProperties" + } + ] + }, + "KeyType": { + "type": "string", + "description": "The Key to be used to generate token for user.", + "enum": [ + "primary", + "secondary" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "KeyVaultContractCreateProperties": { + "type": "object", + "description": "Create keyVault contract details.", + "properties": { + "secretIdentifier": { + "type": "string", + "description": "Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi" + }, + "identityClientId": { + "type": "string", + "description": "Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret." + } + } + }, + "KeyVaultContractProperties": { + "type": "object", + "description": "KeyVault contract details.", + "properties": { + "lastStatus": { + "$ref": "#/definitions/KeyVaultLastAccessStatusContractProperties", + "description": "Last time sync and refresh status of secret from key vault." + } + }, + "allOf": [ + { + "$ref": "#/definitions/KeyVaultContractCreateProperties" + } + ] + }, + "KeyVaultLastAccessStatusContractProperties": { + "type": "object", + "description": "Issue contract Update Properties.", + "properties": { + "code": { + "type": "string", + "description": "Last status code for sync and refresh of secret from key vault." + }, + "message": { + "type": "string", + "description": "Details of the error else empty." + }, + "timeStampUtc": { + "type": "string", + "format": "date-time", + "description": "Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + } + } + }, + "KeyVaultRefreshState": { + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "KeyVaultRefreshState", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "Entities for which KeyVault refresh failed." + }, + { + "name": "false", + "value": "false", + "description": "Entities for which KeyVault refresh succeeded" + } + ] + } + }, + "LLMDiagnosticSettings": { + "type": "object", + "description": "Diagnostic settings for Large Language Models", + "properties": { + "logs": { + "$ref": "#/definitions/Llm-diagnostic-settings", + "description": "Specifies whether default diagnostic should be enabled for Large Language Models or not." + }, + "requests": { + "$ref": "#/definitions/LLMMessageDiagnosticSettings", + "description": "Diagnostic settings for Large Language Models requests." + }, + "responses": { + "$ref": "#/definitions/LLMMessageDiagnosticSettings", + "description": "Diagnostic settings for Large Language Models responses." + } + } + }, + "LLMMessageDiagnosticSettings": { + "type": "object", + "description": "Diagnostic settings for Large Language Models Messages", + "properties": { + "messages": { + "$ref": "#/definitions/Llm-message-log-types", + "description": "Specifies which message should be logged. Currently there is only 'all' option." + }, + "maxSizeInBytes": { + "type": "integer", + "format": "int32", + "description": "Maximum size of message to logs in bytes. The default size is 32KB.", + "minimum": 1, + "maximum": 262144 + } + } + }, + "LegacyApiState": { + "type": "string", + "description": "Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LegacyApiState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Legacy Configuration API (v1) is enabled for the service and self-hosted gateways can connect to it." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Legacy Configuration API (v1) is disabled for the service and self-hosted gateways can not connect to it." + } + ] + } + }, + "LegacyPortalStatus": { + "type": "string", + "description": "Status of legacy portal in the API Management service.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LegacyPortalStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Legacy Portal is enabled for the service." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Legacy Portal is disabled for the service." + } + ] + } + }, + "Llm-diagnostic-settings": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "Llm-diagnostic-settings", + "modelAsString": true, + "values": [ + { + "name": "enabled", + "value": "enabled", + "description": "Default LLM logs are enabled." + }, + { + "name": "disabled", + "value": "disabled", + "description": "Default LLM logs are disabled." + } + ] + } + }, + "Llm-message-log-types": { + "type": "string", + "enum": [ + "all" + ], + "x-ms-enum": { + "name": "Llm-message-log-types", + "modelAsString": true, + "values": [ + { + "name": "all", + "value": "all", + "description": "Log all messages." + } + ] + } + }, + "LoggerCollection": { + "type": "object", + "description": "Paged Logger list representation.", + "properties": { + "value": { + "type": "array", + "description": "Logger values.", + "items": { + "$ref": "#/definitions/LoggerContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "LoggerContract": { + "type": "object", + "description": "Logger details.", + "properties": { + "properties": { + "$ref": "#/definitions/LoggerContractProperties", + "description": "Logger entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "LoggerContractProperties": { + "type": "object", + "description": "The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.", + "properties": { + "loggerType": { + "$ref": "#/definitions/LoggerType", + "description": "Logger type." + }, + "description": { + "type": "string", + "description": "Logger description.", + "maxLength": 256 + }, + "credentials": { + "type": "object", + "description": "The name and SendRule connection string of the event hub for azureEventHub logger.\nInstrumentation key for applicationInsights logger.", + "additionalProperties": { + "type": "string" + } + }, + "isBuffered": { + "type": "boolean", + "description": "Whether records are buffered in the logger before publishing. Default is assumed to be true." + }, + "resourceId": { + "type": "string", + "description": "Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource)." + } + }, + "required": [ + "loggerType" + ] + }, + "LoggerType": { + "type": "string", + "description": "Logger type.", + "enum": [ + "azureEventHub", + "applicationInsights", + "azureMonitor" + ], + "x-ms-enum": { + "name": "LoggerType", + "modelAsString": true, + "values": [ + { + "name": "azureEventHub", + "value": "azureEventHub", + "description": "Azure Event Hub as log destination." + }, + { + "name": "applicationInsights", + "value": "applicationInsights", + "description": "Azure Application Insights as log destination." + }, + { + "name": "azureMonitor", + "value": "azureMonitor", + "description": "Azure Monitor" + } + ] + } + }, + "LoggerUpdateContract": { + "type": "object", + "description": "Logger update contract.", + "properties": { + "properties": { + "$ref": "#/definitions/LoggerUpdateParameters", + "description": "Logger entity update contract properties.", + "x-ms-client-flatten": true + } + } + }, + "LoggerUpdateParameters": { + "type": "object", + "description": "Parameters supplied to the Update Logger operation.", + "properties": { + "loggerType": { + "$ref": "#/definitions/LoggerType", + "description": "Logger type." + }, + "description": { + "type": "string", + "description": "Logger description." + }, + "credentials": { + "type": "object", + "description": "Logger credentials.", + "additionalProperties": { + "type": "string" + } + }, + "isBuffered": { + "type": "boolean", + "description": "Whether records are buffered in the logger before publishing. Default is assumed to be true." + } + } + }, + "Method": { + "type": "string", + "description": "The HTTP method to be used.", + "enum": [ + "GET", + "POST" + ], + "x-ms-enum": { + "name": "Method", + "modelAsString": true, + "values": [ + { + "name": "GET", + "value": "GET" + }, + { + "name": "POST", + "value": "POST" + } + ] + } + }, + "MigrateToStv2Contract": { + "type": "object", + "description": "Describes an available API Management SKU.", + "properties": { + "mode": { + "$ref": "#/definitions/MigrateToStv2Mode", + "description": "Mode of Migration to stv2. Default is PreserveIp." + } + } + }, + "MigrateToStv2Mode": { + "type": "string", + "description": "Mode of Migration to stv2. Default is PreserveIp.", + "enum": [ + "PreserveIp", + "NewIP" + ], + "x-ms-enum": { + "name": "MigrateToStv2Mode", + "modelAsString": true, + "values": [ + { + "name": "PreserveIp", + "value": "PreserveIp", + "description": "Migrate API Management service to stv2 from stv1, by reserving the IP Address of the service. This will have a downtime of upto 15 minutes, while the IP address is getting migrate to new infrastructure." + }, + { + "name": "NewIP", + "value": "NewIP", + "description": "Migrate API Management service to stv2 from stv1. This will have no downtime as the service configuration will be migrated to new infrastructure, but the IP address will changed." + } + ] + } + }, + "NameAvailabilityReason": { + "type": "string", + "description": "Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.", + "enum": [ + "Valid", + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "NameAvailabilityReason", + "modelAsString": false + } + }, + "NamedValueCollection": { + "type": "object", + "description": "Paged NamedValue list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/NamedValueContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "NamedValueContract": { + "type": "object", + "description": "NamedValue details.", + "properties": { + "properties": { + "$ref": "#/definitions/NamedValueContractProperties", + "description": "NamedValue entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "NamedValueContractProperties": { + "type": "object", + "description": "NamedValue Contract properties.", + "properties": { + "displayName": { + "type": "string", + "description": "Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-._]+$" + }, + "value": { + "type": "string", + "description": "Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "maxLength": 4096 + }, + "keyVault": { + "$ref": "#/definitions/KeyVaultContractProperties", + "description": "KeyVault location details of the namedValue." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state", + "readOnly": true + } + }, + "required": [ + "displayName" + ], + "allOf": [ + { + "$ref": "#/definitions/NamedValueEntityBaseParameters" + } + ] + }, + "NamedValueCreateContract": { + "type": "object", + "description": "NamedValue details.", + "properties": { + "properties": { + "$ref": "#/definitions/NamedValueCreateContractProperties", + "description": "NamedValue entity contract properties for PUT operation.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "NamedValueCreateContractProperties": { + "type": "object", + "description": "NamedValue Contract properties.", + "properties": { + "displayName": { + "type": "string", + "description": "Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-._]+$" + }, + "value": { + "type": "string", + "description": "Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "maxLength": 4096 + }, + "keyVault": { + "$ref": "#/definitions/KeyVaultContractCreateProperties", + "description": "KeyVault location details of the namedValue." + } + }, + "required": [ + "displayName" + ], + "allOf": [ + { + "$ref": "#/definitions/NamedValueEntityBaseParameters" + } + ] + }, + "NamedValueEntityBaseParameters": { + "type": "object", + "description": "NamedValue Entity Base Parameters set.", + "properties": { + "tags": { + "type": "array", + "description": "Optional tags that when provided can be used to filter the NamedValue list.", + "maxItems": 32, + "items": { + "type": "string" + } + }, + "secret": { + "type": "boolean", + "description": "Determines whether the value is a secret and should be encrypted or not. Default value is false." + } + } + }, + "NamedValueSecretContract": { + "type": "object", + "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.", + "properties": { + "value": { + "type": "string", + "description": "This is secret value of the NamedValue entity." + } + } + }, + "NamedValueUpdateParameterProperties": { + "type": "object", + "description": "NamedValue Contract properties.", + "properties": { + "displayName": { + "type": "string", + "description": "Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-._]+$" + }, + "value": { + "type": "string", + "description": "Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace.", + "minLength": 1, + "maxLength": 4096 + }, + "keyVault": { + "$ref": "#/definitions/KeyVaultContractCreateProperties", + "description": "KeyVault location details of the namedValue." + } + }, + "allOf": [ + { + "$ref": "#/definitions/NamedValueEntityBaseParameters" + } + ] + }, + "NamedValueUpdateParameters": { + "type": "object", + "description": "NamedValue update Parameters.", + "properties": { + "properties": { + "$ref": "#/definitions/NamedValueUpdateParameterProperties", + "description": "NamedValue entity Update contract properties.", + "x-ms-client-flatten": true + } + } + }, + "NatGatewayState": { + "type": "string", + "description": "Property can be used to enable NAT Gateway for this API Management service.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "NatGatewayState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Nat Gateway is enabled for the service." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Nat Gateway is disabled for the service." + } + ] + } + }, + "NetworkStatusContract": { + "type": "object", + "description": "Network Status details.", + "properties": { + "dnsServers": { + "type": "array", + "description": "Gets the list of DNS servers IPV4 addresses.", + "items": { + "type": "string" + } + }, + "connectivityStatus": { + "type": "array", + "description": "Gets the list of Connectivity Status to the Resources on which the service depends upon.", + "items": { + "$ref": "#/definitions/ConnectivityStatusContract" + }, + "x-ms-identifiers": [ + "name", + "resourceType" + ] + } + }, + "required": [ + "dnsServers", + "connectivityStatus" + ] + }, + "NetworkStatusContractByLocation": { + "type": "object", + "description": "Network Status in the Location", + "properties": { + "location": { + "type": "string", + "description": "Location of service", + "minLength": 1 + }, + "networkStatus": { + "$ref": "#/definitions/NetworkStatusContract", + "description": "Network status in Location" + } + } + }, + "NotificationCollection": { + "type": "object", + "description": "Paged Notification list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/NotificationContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "NotificationContract": { + "type": "object", + "description": "Notification details.", + "properties": { + "properties": { + "$ref": "#/definitions/NotificationContractProperties", + "description": "Notification entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "NotificationContractProperties": { + "type": "object", + "description": "Notification Contract properties.", + "properties": { + "title": { + "type": "string", + "description": "Title of the Notification.", + "minLength": 1, + "maxLength": 1000 + }, + "description": { + "type": "string", + "description": "Description of the Notification." + }, + "recipients": { + "$ref": "#/definitions/RecipientsContractProperties", + "description": "Recipient Parameter values." + } + }, + "required": [ + "title" + ] + }, + "NotificationName": { + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "name": "RequestPublisherNotificationMessage", + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "name": "PurchasePublisherNotificationMessage", + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "name": "NewApplicationNotificationMessage", + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "name": "BCC", + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "name": "NewIssuePublisherNotificationMessage", + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "name": "AccountClosedPublisher", + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + } + }, + "OAuth2AuthenticationSettingsContract": { + "type": "object", + "description": "API OAuth2 Authentication settings details.", + "properties": { + "authorizationServerId": { + "type": "string", + "description": "OAuth authorization server identifier." + }, + "scope": { + "type": "string", + "description": "operations scope." + } + } + }, + "OAuth2GrantType": { + "type": "string", + "description": "OAuth2 grant type options", + "enum": [ + "AuthorizationCode", + "ClientCredentials" + ], + "x-ms-enum": { + "name": "OAuth2GrantType", + "modelAsString": true, + "values": [ + { + "name": "AuthorizationCode", + "value": "AuthorizationCode", + "description": "Authorization Code grant" + }, + { + "name": "ClientCredentials", + "value": "ClientCredentials", + "description": "Client Credential grant" + } + ] + } + }, + "OpenIdAuthenticationSettingsContract": { + "type": "object", + "description": "API OAuth2 Authentication settings details.", + "properties": { + "openidProviderId": { + "type": "string", + "description": "OAuth authorization server identifier." + }, + "bearerTokenSendingMethods": { + "type": "array", + "description": "How to send token to the server.", + "items": { + "$ref": "#/definitions/BearerTokenSendingMethods" + } + } + } + }, + "OpenIdConnectProviderCollection": { + "type": "object", + "description": "Paged OpenIdProviders list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/OpenidConnectProviderContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "OpenidConnectProviderContract": { + "type": "object", + "description": "OpenId Connect Provider details.", + "properties": { + "properties": { + "$ref": "#/definitions/OpenidConnectProviderContractProperties", + "description": "OpenId Connect Provider contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "OpenidConnectProviderContractProperties": { + "type": "object", + "description": "OpenID Connect Providers Contract.", + "properties": { + "displayName": { + "type": "string", + "description": "User-friendly OpenID Connect Provider name.", + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "User-friendly description of OpenID Connect Provider." + }, + "metadataEndpoint": { + "type": "string", + "description": "Metadata endpoint URI." + }, + "clientId": { + "type": "string", + "description": "Client ID of developer console which is the client application." + }, + "clientSecret": { + "type": "string", + "format": "password", + "description": "Client Secret of developer console which is the client application.", + "x-ms-secret": true + }, + "useInTestConsole": { + "type": "boolean", + "description": "If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided." + }, + "useInApiDocumentation": { + "type": "boolean", + "description": "If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided." + } + }, + "required": [ + "displayName", + "metadataEndpoint", + "clientId" + ] + }, + "OpenidConnectProviderUpdateContract": { + "type": "object", + "description": "Parameters supplied to the Update OpenID Connect Provider operation.", + "properties": { + "properties": { + "$ref": "#/definitions/OpenidConnectProviderUpdateContractProperties", + "description": "OpenId Connect Provider Update contract properties.", + "x-ms-client-flatten": true + } + } + }, + "OpenidConnectProviderUpdateContractProperties": { + "type": "object", + "description": "Parameters supplied to the Update OpenID Connect Provider operation.", + "properties": { + "displayName": { + "type": "string", + "description": "User-friendly OpenID Connect Provider name.", + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "User-friendly description of OpenID Connect Provider." + }, + "metadataEndpoint": { + "type": "string", + "description": "Metadata endpoint URI." + }, + "clientId": { + "type": "string", + "description": "Client ID of developer console which is the client application." + }, + "clientSecret": { + "type": "string", + "format": "password", + "description": "Client Secret of developer console which is the client application.", + "x-ms-secret": true + }, + "useInTestConsole": { + "type": "boolean", + "description": "If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided." + }, + "useInApiDocumentation": { + "type": "boolean", + "description": "If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided." + } + } + }, + "Operation": { + "type": "object", + "description": "REST API operation", + "properties": { + "name": { + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The object that describes the operation." + }, + "origin": { + "type": "string", + "description": "The operation origin." + }, + "properties": { + "description": "The operation properties.", + "x-ms-client-flatten": true + } + } + }, + "OperationCollection": { + "type": "object", + "description": "Paged Operation list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/OperationContract" + }, + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "OperationContract": { + "type": "object", + "description": "API Operation details.", + "properties": { + "properties": { + "$ref": "#/definitions/OperationContractProperties", + "description": "Properties of the Operation Contract.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "OperationContractProperties": { + "type": "object", + "description": "Operation Contract Properties", + "properties": { + "displayName": { + "type": "string", + "description": "Operation Name.", + "minLength": 1, + "maxLength": 300 + }, + "method": { + "type": "string", + "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them." + }, + "urlTemplate": { + "type": "string", + "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", + "minLength": 1, + "maxLength": 1000 + } + }, + "required": [ + "displayName", + "method", + "urlTemplate" + ], + "allOf": [ + { + "$ref": "#/definitions/OperationEntityBaseContract" + } + ] + }, + "OperationDisplay": { + "type": "object", + "description": "The object that describes the operation.", + "properties": { + "provider": { + "type": "string", + "description": "Friendly name of the resource provider" + }, + "operation": { + "type": "string", + "description": "Operation type: read, write, delete, listKeys/action, etc." + }, + "resource": { + "type": "string", + "description": "Resource type on which the operation is performed." + }, + "description": { + "type": "string", + "description": "Friendly name of the operation" + } + } + }, + "OperationEntityBaseContract": { + "type": "object", + "description": "API Operation Entity Base Contract details.", + "properties": { + "templateParameters": { + "type": "array", + "description": "Collection of URL template parameters.", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + }, + "description": { + "type": "string", + "description": "Description of the operation. May include HTML formatting tags.", + "maxLength": 1000 + }, + "request": { + "$ref": "#/definitions/RequestContract", + "description": "An entity containing request details." + }, + "responses": { + "type": "array", + "description": "Array of Operation responses.", + "items": { + "$ref": "#/definitions/ResponseContract" + }, + "x-ms-identifiers": [] + }, + "policies": { + "type": "string", + "description": "Operation Policies" + } + } + }, + "OperationListResult": { + "type": "object", + "description": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "description": "List of operations supported by the resource provider.", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "OperationNameFormat": { + "type": "string", + "description": "The format of the Operation Name for Application Insights telemetries. Default is Name.", + "enum": [ + "Name", + "Url" + ], + "x-ms-enum": { + "name": "OperationNameFormat", + "modelAsString": true, + "values": [ + { + "name": "Name", + "value": "Name", + "description": "API_NAME;rev=API_REVISION - OPERATION_NAME" + }, + { + "name": "Url", + "value": "Url", + "description": "HTTP_VERB URL" + } + ] + } + }, + "OperationResultContract": { + "type": "object", + "description": "Long Running Git Operation Results.", + "properties": { + "properties": { + "$ref": "#/definitions/OperationResultContractProperties", + "description": "Properties of the Operation Contract.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "OperationResultContractProperties": { + "type": "object", + "description": "Operation Result.", + "properties": { + "id": { + "type": "string", + "description": "Operation result identifier." + }, + "status": { + "$ref": "#/definitions/AsyncOperationStatus", + "description": "Status of an async operation." + }, + "started": { + "type": "string", + "format": "date-time", + "description": "Start time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "updated": { + "type": "string", + "format": "date-time", + "description": "Last update time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "resultInfo": { + "type": "string", + "description": "Optional result info." + }, + "error": { + "$ref": "#/definitions/ErrorResponseBody", + "description": "Error Body Contract" + }, + "actionLog": { + "type": "array", + "description": "This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation.", + "items": { + "$ref": "#/definitions/OperationResultLogItemContract" + }, + "readOnly": true, + "x-ms-identifiers": [ + "objectKey" + ] + } + } + }, + "OperationResultLogItemContract": { + "type": "object", + "description": "Log of the entity being created, updated or deleted.", + "properties": { + "objectType": { + "type": "string", + "description": "The type of entity contract." + }, + "action": { + "type": "string", + "description": "Action like create/update/delete." + }, + "objectKey": { + "type": "string", + "description": "Identifier of the entity being created/updated/deleted." + } + } + }, + "OperationTagResourceContractProperties": { + "type": "object", + "description": "Operation Entity contract Properties.", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the operation in form /operations/{operationId}." + }, + "name": { + "type": "string", + "description": "Operation name.", + "readOnly": true + }, + "apiName": { + "type": "string", + "description": "API Name.", + "readOnly": true + }, + "apiRevision": { + "type": "string", + "description": "API Revision.", + "readOnly": true + }, + "apiVersion": { + "type": "string", + "description": "API Version.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Operation Description.", + "readOnly": true + }, + "method": { + "type": "string", + "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.", + "readOnly": true + }, + "urlTemplate": { + "type": "string", + "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", + "readOnly": true + } + } + }, + "OperationUpdateContract": { + "type": "object", + "description": "API Operation Update Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/OperationUpdateContractProperties", + "description": "Properties of the API Operation entity that can be updated.", + "x-ms-client-flatten": true + } + } + }, + "OperationUpdateContractProperties": { + "type": "object", + "description": "Operation Update Contract Properties.", + "properties": { + "displayName": { + "type": "string", + "description": "Operation Name.", + "minLength": 1, + "maxLength": 300 + }, + "method": { + "type": "string", + "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them." + }, + "urlTemplate": { + "type": "string", + "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", + "minLength": 1, + "maxLength": 1000 + } + }, + "allOf": [ + { + "$ref": "#/definitions/OperationEntityBaseContract" + } + ] + }, + "Origin": { + "type": "string", + "description": "The origin of the issue.", + "enum": [ + "Local", + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true, + "values": [ + { + "name": "Local", + "value": "Local" + }, + { + "name": "Inbound", + "value": "Inbound" + }, + { + "name": "Outbound", + "value": "Outbound" + } + ] + } + }, + "OutboundEnvironmentEndpoint": { + "type": "object", + "description": "Endpoints accessed for a common purpose that the Api Management Service requires outbound network access to.", + "properties": { + "category": { + "type": "string", + "description": "The type of service accessed by the Api Management Service, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory." + }, + "endpoints": { + "type": "array", + "description": "The endpoints that the Api Management Service reaches the service at.", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [ + "domainName" + ] + } + } + }, + "OutboundEnvironmentEndpointList": { + "type": "object", + "description": "Collection of Outbound Environment Endpoints", + "properties": { + "value": { + "type": "array", + "description": "Collection of resources.", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "Link to next page of resources.", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "ParameterContract": { + "type": "object", + "description": "Operation parameters details.", + "properties": { + "name": { + "type": "string", + "description": "Parameter name." + }, + "description": { + "type": "string", + "description": "Parameter description." + }, + "type": { + "type": "string", + "description": "Parameter type." + }, + "defaultValue": { + "type": "string", + "description": "Default parameter value." + }, + "required": { + "type": "boolean", + "description": "Specifies whether parameter is required or not." + }, + "values": { + "type": "array", + "description": "Parameter values.", + "items": { + "type": "string" + } + }, + "schemaId": { + "type": "string", + "description": "Schema identifier." + }, + "typeName": { + "type": "string", + "description": "Type name defined by the schema." + }, + "examples": { + "type": "object", + "description": "Exampled defined for the parameter.", + "additionalProperties": { + "$ref": "#/definitions/ParameterExampleContract" + } + } + }, + "required": [ + "name", + "type" + ] + }, + "ParameterExampleContract": { + "type": "object", + "description": "Parameter example.", + "properties": { + "summary": { + "type": "string", + "description": "Short description for the example" + }, + "description": { + "type": "string", + "description": "Long description for the example" + }, + "value": { + "description": "Example value. May be a primitive value, or an object." + }, + "externalValue": { + "type": "string", + "description": "A URL that points to the literal example" + } + } + }, + "PipelineDiagnosticSettings": { + "type": "object", + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.", + "properties": { + "request": { + "$ref": "#/definitions/HttpMessageDiagnostic", + "description": "Diagnostic settings for request." + }, + "response": { + "$ref": "#/definitions/HttpMessageDiagnostic", + "description": "Diagnostic settings for response." + } + } + }, + "PlatformVersion": { + "type": "string", + "description": "Compute Platform Version running the service.", + "enum": [ + "undetermined", + "stv1", + "stv2", + "mtv1", + "stv2.1" + ], + "x-ms-enum": { + "name": "PlatformVersion", + "modelAsString": true, + "values": [ + { + "name": "undetermined", + "value": "undetermined", + "description": "Platform version cannot be determined, as compute platform is not deployed." + }, + { + "name": "stv1", + "value": "stv1", + "description": "Platform running the service on Single Tenant V1 platform." + }, + { + "name": "stv2", + "value": "stv2", + "description": "Platform running the service on Single Tenant V2 platform." + }, + { + "name": "mtv1", + "value": "mtv1", + "description": "Platform running the service on Multi Tenant V1 platform." + }, + { + "name": "stv2.1", + "value": "stv2.1", + "description": "Platform running the service on Single Tenant V2 platform on newer Hardware." + } + ] + } + }, + "PolicyCollection": { + "type": "object", + "description": "The response of the list policy operation.", + "properties": { + "value": { + "type": "array", + "description": "Policy Contract value.", + "items": { + "$ref": "#/definitions/PolicyContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "PolicyComplianceState": { + "type": "string", + "description": "Policy Restriction Compliance State", + "enum": [ + "Pending", + "NonCompliant", + "Compliant" + ], + "x-ms-enum": { + "name": "PolicyComplianceState", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "The policy restriction compliance state has not yet been determined." + }, + { + "name": "NonCompliant", + "value": "NonCompliant", + "description": "The scope in restriction is out of compliance." + }, + { + "name": "Compliant", + "value": "Compliant", + "description": "The scope in restriction is in compliance." + } + ] + } + }, + "PolicyContentFormat": { + "type": "string", + "description": "Format of the policyContent.", + "enum": [ + "xml", + "xml-link", + "rawxml", + "rawxml-link" + ], + "x-ms-enum": { + "name": "PolicyContentFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "xml-link", + "value": "xml-link", + "description": "The policy XML document is hosted on a HTTP endpoint accessible from the API Management service." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + }, + { + "name": "rawxml-link", + "value": "rawxml-link", + "description": "The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service." + } + ] + } + }, + "PolicyContract": { + "type": "object", + "description": "Policy Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/PolicyContractProperties", + "description": "Properties of the Policy.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PolicyContractProperties": { + "type": "object", + "description": "Policy contract Properties.", + "properties": { + "value": { + "type": "string", + "description": "Contents of the Policy as defined by the format." + }, + "format": { + "type": "string", + "description": "Format of the policyContent.", + "default": "xml", + "enum": [ + "xml", + "xml-link", + "rawxml", + "rawxml-link" + ], + "x-ms-enum": { + "name": "PolicyContentFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "xml-link", + "value": "xml-link", + "description": "The policy XML document is hosted on a HTTP endpoint accessible from the API Management service." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + }, + { + "name": "rawxml-link", + "value": "rawxml-link", + "description": "The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service." + } + ] + } + } + }, + "required": [ + "value" + ] + }, + "PolicyDescriptionCollection": { + "type": "object", + "description": "Descriptions of API Management policies.", + "properties": { + "value": { + "type": "array", + "description": "Descriptions of API Management policies.", + "items": { + "$ref": "#/definitions/PolicyDescriptionContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + } + } + }, + "PolicyDescriptionContract": { + "type": "object", + "description": "Policy description details.", + "properties": { + "properties": { + "$ref": "#/definitions/PolicyDescriptionContractProperties", + "description": "Policy description contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PolicyDescriptionContractProperties": { + "type": "object", + "description": "Policy description properties.", + "properties": { + "description": { + "type": "string", + "description": "Policy description.", + "readOnly": true + }, + "scope": { + "type": "integer", + "format": "int64", + "description": "Binary OR value of the Snippet scope.", + "readOnly": true + } + } + }, + "PolicyExportFormat": { + "type": "string", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyExportFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + } + }, + "PolicyFragmentCollection": { + "type": "object", + "description": "The response of the get policy fragments operation.", + "properties": { + "value": { + "type": "array", + "description": "Policy fragment contract value.", + "items": { + "$ref": "#/definitions/PolicyFragmentContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "PolicyFragmentContentFormat": { + "type": "string", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyFragmentContentFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + } + }, + "PolicyFragmentContract": { + "type": "object", + "description": "Policy fragment contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/PolicyFragmentContractProperties", + "description": "Properties of the Policy Fragment.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PolicyFragmentContractProperties": { + "type": "object", + "description": "Policy fragment contract properties.", + "properties": { + "value": { + "type": "string", + "description": "Contents of the policy fragment." + }, + "description": { + "type": "string", + "description": "Policy fragment description.", + "minLength": 0, + "maxLength": 1000 + }, + "format": { + "type": "string", + "description": "Format of the policy fragment content.", + "default": "xml", + "enum": [ + "xml", + "rawxml" + ], + "x-ms-enum": { + "name": "PolicyFragmentContentFormat", + "modelAsString": true, + "values": [ + { + "name": "xml", + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "name": "rawxml", + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + } + ] + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "PolicyIdName": { + "type": "string", + "enum": [ + "policy" + ], + "x-ms-enum": { + "name": "PolicyIdName", + "modelAsString": true, + "values": [ + { + "name": "policy", + "value": "policy" + } + ] + } + }, + "PolicyRestrictionCollection": { + "type": "object", + "description": "The response of the get policy restrictions operation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/PolicyRestrictionContract" + } + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "PolicyRestrictionContract": { + "type": "object", + "description": "Policy restriction contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/PolicyRestrictionContractProperties", + "description": "Properties of the Policy Restriction.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PolicyRestrictionContractProperties": { + "type": "object", + "description": "Policy restrictions contract properties.", + "properties": { + "scope": { + "type": "string", + "description": "Path to the policy document." + }, + "requireBase": { + "type": "string", + "description": "Indicates if base policy should be enforced for the policy document.", + "default": "false", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "PolicyRestrictionRequireBase", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "The policy is required to have base policy" + }, + { + "name": "false", + "value": "false", + "description": "The policy does not require to have base policy" + } + ] + } + } + } + }, + "PolicyRestrictionRequireBase": { + "type": "string", + "description": "Indicates if base policy should be enforced for the policy document.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "PolicyRestrictionRequireBase", + "modelAsString": true, + "values": [ + { + "name": "true", + "value": "true", + "description": "The policy is required to have base policy" + }, + { + "name": "false", + "value": "false", + "description": "The policy does not require to have base policy" + } + ] + } + }, + "PolicyRestrictionUpdateContract": { + "type": "object", + "description": "Policy restriction contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/PolicyRestrictionContractProperties", + "description": "Properties of the Policy Restriction.", + "x-ms-client-flatten": true + } + } + }, + "PolicyScopeContract": { + "type": "string", + "enum": [ + "Tenant", + "Product", + "Api", + "Operation", + "All" + ], + "x-ms-enum": { + "name": "PolicyScopeContract", + "modelAsString": false + } + }, + "PolicyWithComplianceCollection": { + "type": "object", + "description": "The response of the list policy operation.", + "properties": { + "value": { + "type": "array", + "description": "Policy Contract value.", + "items": { + "$ref": "#/definitions/PolicyWithComplianceContract" + } + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "PolicyWithComplianceContract": { + "type": "object", + "description": "Policy Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/PolicyWithComplianceContractProperties", + "description": "Properties of the Policy.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PolicyWithComplianceContractProperties": { + "type": "object", + "description": "Policy contract Properties.", + "properties": { + "referencePolicyId": { + "type": "string", + "description": "Policy Identifier" + }, + "complianceState": { + "type": "string", + "description": "Policy Restriction Compliance State", + "default": "Pending", + "enum": [ + "Pending", + "NonCompliant", + "Compliant" + ], + "x-ms-enum": { + "name": "PolicyComplianceState", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "The policy restriction compliance state has not yet been determined." + }, + { + "name": "NonCompliant", + "value": "NonCompliant", + "description": "The scope in restriction is out of compliance." + }, + { + "name": "Compliant", + "value": "Compliant", + "description": "The scope in restriction is in compliance." + } + ] + } + } + } + }, + "PortalConfigCollection": { + "type": "object", + "description": "The collection of the developer portal configurations.", + "properties": { + "value": { + "type": "array", + "description": "The developer portal configurations.", + "items": { + "$ref": "#/definitions/PortalConfigContract" + } + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "PortalConfigContract": { + "type": "object", + "description": "The developer portal configuration contract.", + "properties": { + "properties": { + "$ref": "#/definitions/PortalConfigProperties", + "description": "The developer portal configuration contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PortalConfigCorsProperties": { + "type": "object", + "description": "The developer portal Cross-Origin Resource Sharing (CORS) settings.", + "properties": { + "allowedOrigins": { + "type": "array", + "description": "Allowed origins, e.g. `https://trusted.com`.", + "items": { + "type": "string" + } + } + } + }, + "PortalConfigCspProperties": { + "type": "object", + "description": "The developer portal Content Security Policy (CSP) settings.", + "properties": { + "mode": { + "type": "string", + "description": "The mode of the developer portal Content Security Policy (CSP).", + "default": "disabled", + "enum": [ + "enabled", + "disabled", + "reportOnly" + ], + "x-ms-enum": { + "name": "PortalSettingsCspMode", + "modelAsString": true, + "values": [ + { + "name": "enabled", + "value": "enabled", + "description": "The browser will block requests not matching allowed origins." + }, + { + "name": "disabled", + "value": "disabled", + "description": "The browser will not apply the origin restrictions." + }, + { + "name": "reportOnly", + "value": "reportOnly", + "description": "The browser will report requests not matching allowed origins without blocking them." + } + ] + } + }, + "reportUri": { + "type": "array", + "description": "The URLs used by the browser to report CSP violations.", + "items": { + "type": "string" + } + }, + "allowedSources": { + "type": "array", + "description": "Allowed sources, e.g. `*.trusted.com`, `trusted.com`, `https://`.", + "items": { + "type": "string" + } + } + } + }, + "PortalConfigDelegationProperties": { + "type": "object", + "properties": { + "delegateRegistration": { + "type": "boolean", + "description": "Enable or disable delegation for user registration.", + "default": false + }, + "delegateSubscription": { + "type": "boolean", + "description": "Enable or disable delegation for product subscriptions.", + "default": false + }, + "delegationUrl": { + "type": "string", + "description": "A delegation endpoint URL." + }, + "validationKey": { + "type": "string", + "format": "password", + "description": "A base64-encoded validation key to ensure requests originate from Azure API Management service.", + "x-ms-secret": true + } + } + }, + "PortalConfigProperties": { + "type": "object", + "description": "The developer portal configuration contract properties.", + "properties": { + "enableBasicAuth": { + "type": "boolean", + "description": "Enable or disable Basic authentication method.", + "default": true + }, + "signin": { + "$ref": "#/definitions/PortalConfigPropertiesSignin" + }, + "signup": { + "$ref": "#/definitions/PortalConfigPropertiesSignup" + }, + "delegation": { + "$ref": "#/definitions/PortalConfigDelegationProperties", + "description": "The developer portal delegation settings." + }, + "cors": { + "$ref": "#/definitions/PortalConfigCorsProperties", + "description": "The developer portal Cross-Origin Resource Sharing (CORS) settings." + }, + "csp": { + "$ref": "#/definitions/PortalConfigCspProperties", + "description": "The developer portal Content Security Policy (CSP) settings." + } + } + }, + "PortalConfigPropertiesSignin": { + "type": "object", + "properties": { + "require": { + "type": "boolean", + "description": "Redirect anonymous users to the sign-in page.", + "default": false + } + } + }, + "PortalConfigPropertiesSignup": { + "type": "object", + "properties": { + "termsOfService": { + "$ref": "#/definitions/PortalConfigTermsOfServiceProperties", + "description": "Terms of service settings." + } + } + }, + "PortalConfigTermsOfServiceProperties": { + "type": "object", + "description": "Terms of service contract properties.", + "properties": { + "text": { + "type": "string", + "description": "A terms of service text." + }, + "requireConsent": { + "type": "boolean", + "description": "Ask user for consent to the terms of service.", + "default": false + } + } + }, + "PortalDelegationSettings": { + "type": "object", + "description": "Delegation settings for a developer portal.", + "properties": { + "properties": { + "$ref": "#/definitions/PortalDelegationSettingsProperties", + "description": "Delegation settings contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PortalDelegationSettingsProperties": { + "type": "object", + "description": "Delegation settings contract properties.", + "properties": { + "url": { + "type": "string", + "description": "A delegation Url." + }, + "validationKey": { + "type": "string", + "format": "password", + "description": "A base64-encoded validation key to validate, that a request is coming from Azure API Management.", + "x-ms-secret": true + }, + "subscriptions": { + "$ref": "#/definitions/SubscriptionsDelegationSettingsProperties", + "description": "Subscriptions delegation settings." + }, + "userRegistration": { + "$ref": "#/definitions/RegistrationDelegationSettingsProperties", + "description": "User registration delegation settings." + } + } + }, + "PortalRevisionCollection": { + "type": "object", + "description": "Paged list of portal revisions.", + "properties": { + "value": { + "type": "array", + "description": "Collection of portal revisions.", + "items": { + "$ref": "#/definitions/PortalRevisionContract" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link, if any.", + "readOnly": true + } + } + }, + "PortalRevisionContract": { + "type": "object", + "description": "Portal Revision's contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/PortalRevisionContractProperties", + "description": "Properties of the portal revisions.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PortalRevisionContractProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Portal revision description.", + "maxLength": 2000 + }, + "statusDetails": { + "type": "string", + "description": "Portal revision publishing status details.", + "maxLength": 2000, + "readOnly": true + }, + "status": { + "$ref": "#/definitions/PortalRevisionStatus", + "description": "Status of the portal's revision.", + "readOnly": true + }, + "isCurrent": { + "type": "boolean", + "description": "Indicates if the portal's revision is public." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "Portal's revision creation date and time.", + "readOnly": true + }, + "updatedDateTime": { + "type": "string", + "format": "date-time", + "description": "Last updated date and time.", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state", + "readOnly": true + } + } + }, + "PortalRevisionStatus": { + "type": "string", + "description": "Status of the portal's revision.", + "enum": [ + "pending", + "publishing", + "completed", + "failed" + ], + "x-ms-enum": { + "name": "PortalRevisionStatus", + "modelAsString": true, + "values": [ + { + "name": "pending", + "value": "pending", + "description": "Portal's revision has been queued." + }, + { + "name": "publishing", + "value": "publishing", + "description": "Portal's revision is being published." + }, + { + "name": "completed", + "value": "completed", + "description": "Portal's revision publishing completed." + }, + { + "name": "failed", + "value": "failed", + "description": "Portal's revision publishing failed." + } + ] + } + }, + "PortalSettingValidationKeyContract": { + "type": "object", + "description": "Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.", + "properties": { + "validationKey": { + "type": "string", + "format": "password", + "description": "This is secret value of the validation key in portal settings.", + "x-ms-secret": true + } + } + }, + "PortalSettingsCollection": { + "type": "object", + "description": "Descriptions of API Management policies.", + "properties": { + "value": { + "type": "array", + "description": "Descriptions of API Management policies.", + "items": { + "$ref": "#/definitions/PortalSettingsContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + } + } + }, + "PortalSettingsContract": { + "type": "object", + "description": "Portal Settings for the Developer Portal.", + "properties": { + "properties": { + "$ref": "#/definitions/PortalSettingsContractProperties", + "description": "Portal Settings contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PortalSettingsContractProperties": { + "type": "object", + "description": "Sign-in settings contract properties.", + "properties": { + "url": { + "type": "string", + "description": "A delegation Url." + }, + "validationKey": { + "type": "string", + "format": "password", + "description": "A base64-encoded validation key to validate, that a request is coming from Azure API Management.", + "x-ms-secret": true + }, + "subscriptions": { + "$ref": "#/definitions/SubscriptionsDelegationSettingsProperties", + "description": "Subscriptions delegation settings." + }, + "userRegistration": { + "$ref": "#/definitions/RegistrationDelegationSettingsProperties", + "description": "User registration delegation settings." + }, + "enabled": { + "type": "boolean", + "description": "Redirect Anonymous users to the Sign-In page." + }, + "termsOfService": { + "$ref": "#/definitions/TermsOfServiceProperties", + "description": "Terms of service contract properties." + } + } + }, + "PortalSettingsCspMode": { + "type": "string", + "description": "The mode of the developer portal Content Security Policy (CSP).", + "enum": [ + "enabled", + "disabled", + "reportOnly" + ], + "x-ms-enum": { + "name": "PortalSettingsCspMode", + "modelAsString": true, + "values": [ + { + "name": "enabled", + "value": "enabled", + "description": "The browser will block requests not matching allowed origins." + }, + { + "name": "disabled", + "value": "disabled", + "description": "The browser will not apply the origin restrictions." + }, + { + "name": "reportOnly", + "value": "reportOnly", + "description": "The browser will report requests not matching allowed origins without blocking them." + } + ] + } + }, + "PortalSigninSettingProperties": { + "type": "object", + "description": "Sign-in settings contract properties.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Redirect Anonymous users to the Sign-In page." + } + } + }, + "PortalSigninSettings": { + "type": "object", + "description": "Sign-In settings for the Developer Portal.", + "properties": { + "properties": { + "$ref": "#/definitions/PortalSigninSettingProperties", + "description": "Sign-in settings contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PortalSignupSettings": { + "type": "object", + "description": "Sign-Up settings for a developer portal.", + "properties": { + "properties": { + "$ref": "#/definitions/PortalSignupSettingsProperties", + "description": "Sign-up settings contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PortalSignupSettingsProperties": { + "type": "object", + "description": "Sign-up settings contract properties.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Allow users to sign up on a developer portal." + }, + "termsOfService": { + "$ref": "#/definitions/TermsOfServiceProperties", + "description": "Terms of service contract properties." + } + } + }, + "PreferredIPVersion": { + "type": "string", + "description": "The IP version to be used. Only IPv4 is supported for now.", + "enum": [ + "IPv4" + ], + "x-ms-enum": { + "name": "PreferredIPVersion", + "modelAsString": true, + "values": [ + { + "name": "IPv4", + "value": "IPv4" + } + ] + } + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "The response of a PrivateEndpointConnection list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnection items on this page", + "items": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateEndpointConnectionRequest": { + "type": "object", + "description": "A request to approve or reject a private endpoint connection", + "properties": { + "id": { + "type": "string", + "description": "Private Endpoint Connection Resource Id." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionRequestProperties", + "description": "The connection state of the private endpoint connection." + } + } + }, + "PrivateEndpointConnectionRequestProperties": { + "type": "object", + "description": "The connection state of the private endpoint connection.", + "properties": { + "privateLinkServiceConnectionState": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + } + }, + "PrivateEndpointConnectionWrapperProperties": { + "type": "object", + "description": "Properties of the PrivateEndpointConnectProperties.", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/ArmIdWrapper", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the private endpoint connection resource.", + "readOnly": true + }, + "groupIds": { + "type": "array", + "description": "All the Group ids.", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "The response of a PrivateLinkResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateLinkResource items on this page", + "items": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProductApiLinkCollection": { + "type": "object", + "description": "Paged Product-API link list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/ProductApiLinkContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "ProductApiLinkContract": { + "type": "object", + "description": "Product-API link details.", + "properties": { + "properties": { + "$ref": "#/definitions/ProductApiLinkContractProperties", + "description": "Product-API link entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ProductApiLinkContractProperties": { + "type": "object", + "description": "Product-API link entity properties.", + "properties": { + "apiId": { + "type": "string", + "description": "Full resource Id of an API." + } + }, + "required": [ + "apiId" + ] + }, + "ProductApplicationContract": { + "type": "object", + "description": "Specifies Microsoft Entra settings needed to authorize product API calls using client applications.", + "properties": { + "entra": { + "$ref": "#/definitions/ProductApplicationContractEntra", + "description": "Specifies Microsoft Entra settings needed to authorize product API calls using client application with Microsoft Entra OAuth token." + } + } + }, + "ProductApplicationContractEntra": { + "type": "object", + "description": "Specifies Microsoft Entra settings needed to authorize product API calls using client application with Microsoft Entra OAuth token.", + "properties": { + "applicationId": { + "type": "string", + "description": "Product facing EntraID application client ID." + }, + "audience": { + "type": "string", + "description": "The EntraID application audience claim. The audience claim is used to validate the token." + } + } + }, + "ProductAuthType": { + "type": "string", + "enum": [ + "subscription-key", + "application-token" + ], + "x-ms-enum": { + "name": "ProductAuthType", + "modelAsString": true, + "values": [ + { + "name": "subscription-key", + "value": "subscription-key" + }, + { + "name": "application-token", + "value": "application-token" + } + ] + } + }, + "ProductCollection": { + "type": "object", + "description": "Paged Products list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/ProductContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "ProductContract": { + "type": "object", + "description": "Product details.", + "properties": { + "properties": { + "$ref": "#/definitions/ProductContractProperties", + "description": "Product entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ProductContractProperties": { + "type": "object", + "description": "Product profile.", + "properties": { + "displayName": { + "type": "string", + "description": "Product name.", + "minLength": 1, + "maxLength": 300 + } + }, + "required": [ + "displayName" + ], + "allOf": [ + { + "$ref": "#/definitions/ProductEntityBaseParameters" + } + ] + }, + "ProductEntityBaseParameters": { + "type": "object", + "description": "Product Entity Base Parameters", + "properties": { + "description": { + "type": "string", + "description": "Product description. May include HTML formatting tags.", + "minLength": 0, + "maxLength": 1000 + }, + "terms": { + "type": "string", + "description": "Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process." + }, + "subscriptionRequired": { + "type": "boolean", + "description": "Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as \"protected\" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as \"open\" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true." + }, + "approvalRequired": { + "type": "boolean", + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false." + }, + "subscriptionsLimit": { + "type": "integer", + "format": "int32", + "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + }, + "authenticationType": { + "type": "array", + "description": "Type of supported authentication for the product. The application configuration is required for application-token authentication type. The subscription-key authentication type is used by default. If the property is omitted, the subscription-key authentication type is used.", + "items": { + "$ref": "#/definitions/ProductAuthType" + } + }, + "application": { + "$ref": "#/definitions/ProductEntityBaseParametersApplication", + "description": "Specifies identity provider settings needed to authorize applications API calls." + }, + "state": { + "$ref": "#/definitions/ProductState", + "description": "whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished." + } + } + }, + "ProductEntityBaseParametersApplication": { + "type": "object", + "description": "Specifies identity provider settings needed to authorize applications API calls.", + "allOf": [ + { + "$ref": "#/definitions/ProductApplicationContract" + } + ] + }, + "ProductGroupLinkCollection": { + "type": "object", + "description": "Paged Product-group link list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/ProductGroupLinkContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "ProductGroupLinkContract": { + "type": "object", + "description": "Product-group link details.", + "properties": { + "properties": { + "$ref": "#/definitions/ProductGroupLinkContractProperties", + "description": "Product-group link entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ProductGroupLinkContractProperties": { + "type": "object", + "description": "Product-group link entity properties.", + "properties": { + "groupId": { + "type": "string", + "description": "Full resource Id of a group." + } + }, + "required": [ + "groupId" + ] + }, + "ProductState": { + "type": "string", + "description": "whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.", + "enum": [ + "notPublished", + "published" + ], + "x-ms-enum": { + "name": "ProductState", + "modelAsString": false + } + }, + "ProductTagResourceContractProperties": { + "type": "object", + "description": "Product profile.", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the product in the form of /products/{productId}" + }, + "name": { + "type": "string", + "description": "Product name.", + "minLength": 1, + "maxLength": 300 + } + }, + "required": [ + "name" + ], + "allOf": [ + { + "$ref": "#/definitions/ProductEntityBaseParameters" + } + ] + }, + "ProductUpdateParameters": { + "type": "object", + "description": "Product Update parameters.", + "properties": { + "properties": { + "$ref": "#/definitions/ProductUpdateProperties", + "description": "Product entity Update contract properties.", + "x-ms-client-flatten": true + } + } + }, + "ProductUpdateProperties": { + "type": "object", + "description": "Parameters supplied to the Update Product operation.", + "properties": { + "displayName": { + "type": "string", + "description": "Product name.", + "minLength": 1, + "maxLength": 300 + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProductEntityBaseParameters" + } + ] + }, + "Protocol": { + "type": "string", + "enum": [ + "http", + "https", + "ws", + "wss" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true, + "values": [ + { + "name": "http", + "value": "http" + }, + { + "name": "https", + "value": "https" + }, + { + "name": "ws", + "value": "ws" + }, + { + "name": "wss", + "value": "wss" + } + ] + } + }, + "PublicNetworkAccess": { + "type": "string", + "description": "Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled" + }, + { + "name": "Disabled", + "value": "Disabled" + } + ] + } + }, + "QuotaCounterCollection": { + "type": "object", + "description": "Paged Quota Counter list representation.", + "properties": { + "value": { + "type": "array", + "description": "Quota counter values.", + "items": { + "$ref": "#/definitions/QuotaCounterContract" + }, + "x-ms-identifiers": [ + "counterKey", + "periodKey" + ] + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "QuotaCounterContract": { + "type": "object", + "description": "Quota counter details.", + "properties": { + "counterKey": { + "type": "string", + "description": "The Key value of the Counter. Must not be empty.", + "minLength": 1 + }, + "periodKey": { + "type": "string", + "description": "Identifier of the Period for which the counter was collected. Must not be empty.", + "minLength": 1 + }, + "periodStartTime": { + "type": "string", + "format": "date-time", + "description": "The date of the start of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "periodEndTime": { + "type": "string", + "format": "date-time", + "description": "The date of the end of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "value": { + "$ref": "#/definitions/QuotaCounterValueContractProperties", + "description": "Quota Value Properties" + } + }, + "required": [ + "counterKey", + "periodKey", + "periodStartTime", + "periodEndTime" + ] + }, + "QuotaCounterValueContract": { + "type": "object", + "description": "Quota counter value details.", + "properties": { + "value": { + "$ref": "#/definitions/QuotaCounterValueContractProperties", + "description": "Quota counter Value Properties.", + "x-ms-client-flatten": true + } + } + }, + "QuotaCounterValueContractProperties": { + "type": "object", + "description": "Quota counter value details.", + "properties": { + "callsCount": { + "type": "integer", + "format": "int32", + "description": "Number of times Counter was called." + }, + "kbTransferred": { + "type": "number", + "format": "double", + "description": "Data Transferred in KiloBytes." + } + } + }, + "QuotaCounterValueUpdateContract": { + "type": "object", + "description": "Quota counter value details.", + "properties": { + "properties": { + "$ref": "#/definitions/QuotaCounterValueContractProperties", + "description": "Quota counter value details.", + "x-ms-client-flatten": true + } + } + }, + "RecipientEmailCollection": { + "type": "object", + "description": "Paged Recipient User list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/RecipientEmailContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "RecipientEmailContract": { + "type": "object", + "description": "Recipient Email details.", + "properties": { + "properties": { + "$ref": "#/definitions/RecipientEmailContractProperties", + "description": "Recipient Email contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "RecipientEmailContractProperties": { + "type": "object", + "description": "Recipient Email Contract Properties.", + "properties": { + "email": { + "type": "string", + "description": "User Email subscribed to notification." + } + } + }, + "RecipientUserCollection": { + "type": "object", + "description": "Paged Recipient User list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/RecipientUserContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "RecipientUserContract": { + "type": "object", + "description": "Recipient User details.", + "properties": { + "properties": { + "$ref": "#/definitions/RecipientUsersContractProperties", + "description": "Recipient User entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "RecipientUsersContractProperties": { + "type": "object", + "description": "Recipient User Contract Properties.", + "properties": { + "userId": { + "type": "string", + "description": "API Management UserId subscribed to notification." + } + } + }, + "RecipientsContractProperties": { + "type": "object", + "description": "Notification Parameter contract.", + "properties": { + "emails": { + "type": "array", + "description": "List of Emails subscribed for the notification.", + "items": { + "type": "string" + } + }, + "users": { + "type": "array", + "description": "List of Users subscribed for the notification.", + "items": { + "type": "string" + } + } + } + }, + "RegionContract": { + "type": "object", + "description": "Region profile.", + "properties": { + "name": { + "type": "string", + "description": "Region name.", + "readOnly": true + }, + "isMasterRegion": { + "type": "boolean", + "description": "whether Region is the master region." + }, + "isDeleted": { + "type": "boolean", + "description": "whether Region is deleted." + } + } + }, + "RegionListResult": { + "type": "object", + "description": "Lists Regions operation response details.", + "properties": { + "value": { + "type": "array", + "description": "Lists of Regions.", + "items": { + "$ref": "#/definitions/RegionContract" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "RegistrationDelegationSettingsProperties": { + "type": "object", + "description": "User registration delegation settings properties.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable or disable delegation for user registration." + } + } + }, + "ReleaseChannel": { + "type": "string", + "description": "Release Channel of this API Management service.", + "enum": [ + "Preview", + "Default", + "Stable" + ], + "x-ms-enum": { + "name": "ReleaseChannel", + "modelAsString": true, + "values": [ + { + "name": "Preview", + "value": "Preview", + "description": "Preview Channel of the service." + }, + { + "name": "Default", + "value": "Default", + "description": "Default Channel of the service." + }, + { + "name": "Stable", + "value": "Stable", + "description": "Stable Channel of the service." + } + ] + } + }, + "RemotePrivateEndpointConnectionWrapper": { + "type": "object", + "description": "Remote Private Endpoint Connection resource.", + "properties": { + "id": { + "type": "string", + "description": "Private Endpoint connection resource id" + }, + "name": { + "type": "string", + "description": "Private Endpoint Connection Name" + }, + "type": { + "type": "string", + "description": "Private Endpoint Connection Resource Type" + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionWrapperProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ReportCollection": { + "type": "object", + "description": "Paged Report records list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/ReportRecordContract" + }, + "x-ms-identifiers": [ + "name", + "userId" + ] + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "ReportRecordContract": { + "type": "object", + "description": "Report data.", + "properties": { + "name": { + "type": "string", + "description": "Name depending on report endpoint specifies product, API, operation or developer name." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "interval": { + "type": "string", + "description": "Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations)." + }, + "country": { + "type": "string", + "description": "Country to which this record data is related." + }, + "region": { + "type": "string", + "description": "Country region to which this record data is related." + }, + "zip": { + "type": "string", + "description": "Zip code to which this record data is related." + }, + "userId": { + "type": "string", + "description": "User identifier path. /users/{userId}", + "readOnly": true + }, + "productId": { + "type": "string", + "description": "Product identifier path. /products/{productId}", + "readOnly": true + }, + "apiId": { + "type": "string", + "description": "API identifier path. /apis/{apiId}" + }, + "operationId": { + "type": "string", + "description": "Operation identifier path. /apis/{apiId}/operations/{operationId}" + }, + "apiRegion": { + "type": "string", + "description": "API region identifier." + }, + "subscriptionId": { + "type": "string", + "description": "Subscription identifier path. /subscriptions/{subscriptionId}" + }, + "callCountSuccess": { + "type": "integer", + "format": "int32", + "description": "Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" + }, + "callCountBlocked": { + "type": "integer", + "format": "int32", + "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" + }, + "callCountFailed": { + "type": "integer", + "format": "int32", + "description": "Number of calls failed due to gateway or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600" + }, + "callCountOther": { + "type": "integer", + "format": "int32", + "description": "Number of other calls." + }, + "callCountTotal": { + "type": "integer", + "format": "int32", + "description": "Total number of calls." + }, + "bandwidth": { + "type": "integer", + "format": "int64", + "description": "Bandwidth consumed." + }, + "cacheHitCount": { + "type": "integer", + "format": "int32", + "description": "Number of times when content was served from cache policy." + }, + "cacheMissCount": { + "type": "integer", + "format": "int32", + "description": "Number of times content was fetched from backend." + }, + "apiTimeAvg": { + "type": "number", + "format": "double", + "description": "Average time it took to process request." + }, + "apiTimeMin": { + "type": "number", + "format": "double", + "description": "Minimum time it took to process request." + }, + "apiTimeMax": { + "type": "number", + "format": "double", + "description": "Maximum time it took to process request." + }, + "serviceTimeAvg": { + "type": "number", + "format": "double", + "description": "Average time it took to process request on backend." + }, + "serviceTimeMin": { + "type": "number", + "format": "double", + "description": "Minimum time it took to process request on backend." + }, + "serviceTimeMax": { + "type": "number", + "format": "double", + "description": "Maximum time it took to process request on backend." + } + } + }, + "RepresentationContract": { + "type": "object", + "description": "Operation request/response representation details.", + "properties": { + "contentType": { + "type": "string", + "description": "Specifies a registered or custom content type for this representation, e.g. application/xml." + }, + "schemaId": { + "type": "string", + "description": "Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." + }, + "typeName": { + "type": "string", + "description": "Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." + }, + "formParameters": { + "type": "array", + "description": "Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + }, + "examples": { + "type": "object", + "description": "Exampled defined for the representation.", + "additionalProperties": { + "$ref": "#/definitions/ParameterExampleContract" + } + } + }, + "required": [ + "contentType" + ] + }, + "RequestContract": { + "type": "object", + "description": "Operation request details.", + "properties": { + "description": { + "type": "string", + "description": "Operation request description." + }, + "queryParameters": { + "type": "array", + "description": "Collection of operation request query parameters.", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + }, + "headers": { + "type": "array", + "description": "Collection of operation request headers.", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + }, + "representations": { + "type": "array", + "description": "Collection of operation request representations.", + "items": { + "$ref": "#/definitions/RepresentationContract" + }, + "x-ms-identifiers": [] + } + } + }, + "RequestReportCollection": { + "type": "object", + "description": "Paged Report records list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/RequestReportRecordContract" + }, + "x-ms-identifiers": [ + "url" + ] + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "RequestReportRecordContract": { + "type": "object", + "description": "Request Report data.", + "properties": { + "apiId": { + "type": "string", + "description": "API identifier path. /apis/{apiId}" + }, + "operationId": { + "type": "string", + "description": "Operation identifier path. /apis/{apiId}/operations/{operationId}" + }, + "productId": { + "type": "string", + "description": "Product identifier path. /products/{productId}", + "readOnly": true + }, + "userId": { + "type": "string", + "description": "User identifier path. /users/{userId}", + "readOnly": true + }, + "method": { + "type": "string", + "description": "The HTTP method associated with this request.." + }, + "url": { + "type": "string", + "description": "The full URL associated with this request." + }, + "ipAddress": { + "type": "string", + "description": "The client IP address associated with this request." + }, + "backendResponseCode": { + "type": "string", + "description": "The HTTP status code received by the gateway as a result of forwarding this request to the backend." + }, + "responseCode": { + "type": "integer", + "format": "int32", + "description": "The HTTP status code returned by the gateway." + }, + "responseSize": { + "type": "integer", + "format": "int32", + "description": "The size of the response returned by the gateway." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when this request was received by the gateway in ISO 8601 format." + }, + "cache": { + "type": "string", + "description": "Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend." + }, + "apiTime": { + "type": "number", + "format": "double", + "description": "The total time it took to process this request." + }, + "serviceTime": { + "type": "number", + "format": "double", + "description": "he time it took to forward this request to the backend and get the response back." + }, + "apiRegion": { + "type": "string", + "description": "Azure region where the gateway that processed this request is located." + }, + "subscriptionId": { + "type": "string", + "description": "Subscription identifier path. /subscriptions/{subscriptionId}" + }, + "requestId": { + "type": "string", + "description": "Request Identifier." + }, + "requestSize": { + "type": "integer", + "format": "int32", + "description": "The size of this request.." + } + } + }, + "ResolverCollection": { + "type": "object", + "description": "Paged Resolver list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/ResolverContract" + }, + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "ResolverContract": { + "type": "object", + "description": "GraphQL API Resolver details.", + "properties": { + "properties": { + "$ref": "#/definitions/ResolverEntityBaseContract", + "description": "Properties of the Resolver Contract.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ResolverEntityBaseContract": { + "type": "object", + "description": "GraphQL API Resolver Entity Base Contract details.", + "properties": { + "displayName": { + "type": "string", + "description": "Resolver Name.", + "minLength": 1, + "maxLength": 300 + }, + "path": { + "type": "string", + "description": "Path is type/field being resolved.", + "minLength": 1, + "maxLength": 300 + }, + "description": { + "type": "string", + "description": "Description of the resolver. May include HTML formatting tags.", + "maxLength": 1000 + } + } + }, + "ResolverResultContract": { + "type": "object", + "description": "Long Running Git Resolver Results.", + "properties": { + "properties": { + "$ref": "#/definitions/ResolverResultContractProperties", + "description": "Properties of the Resolver Contract.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ResolverResultContractProperties": { + "type": "object", + "description": "Resolver Result.", + "properties": { + "id": { + "type": "string", + "description": "Resolver result identifier." + }, + "status": { + "$ref": "#/definitions/AsyncResolverStatus", + "description": "Status of an async resolver." + }, + "started": { + "type": "string", + "format": "date-time", + "description": "Start time of an async resolver. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "updated": { + "type": "string", + "format": "date-time", + "description": "Last update time of an async resolver. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "resultInfo": { + "type": "string", + "description": "Optional result info." + }, + "error": { + "$ref": "#/definitions/ErrorResponseBody", + "description": "Error Body Contract" + }, + "actionLog": { + "type": "array", + "description": "This property if only provided as part of the TenantConfiguration_Validate resolver. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy resolver.", + "items": { + "$ref": "#/definitions/ResolverResultLogItemContract" + }, + "readOnly": true, + "x-ms-identifiers": [ + "objectKey" + ] + } + } + }, + "ResolverResultLogItemContract": { + "type": "object", + "description": "Log of the entity being created, updated or deleted.", + "properties": { + "objectType": { + "type": "string", + "description": "The type of entity contract." + }, + "action": { + "type": "string", + "description": "Action like create/update/delete." + }, + "objectKey": { + "type": "string", + "description": "Identifier of the entity being created/updated/deleted." + } + } + }, + "ResolverUpdateContract": { + "type": "object", + "description": "GraphQL API Resolver Update Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/ResolverUpdateContractProperties", + "description": "Properties of the GraphQL API Resolver entity that can be updated.", + "x-ms-client-flatten": true + } + } + }, + "ResolverUpdateContractProperties": { + "type": "object", + "description": "Resolver Update Contract Properties.", + "properties": { + "displayName": { + "type": "string", + "description": "Resolver Name.", + "minLength": 1, + "maxLength": 300 + }, + "path": { + "type": "string", + "description": "Path is type/field being resolved.", + "minLength": 1, + "maxLength": 300 + }, + "description": { + "type": "string", + "description": "Description of the resolver. May include HTML formatting tags.", + "maxLength": 1000 + } + } + }, + "ResourceCollection": { + "type": "object", + "description": "A collection of resources.", + "properties": { + "value": { + "type": "array", + "description": "A collection of resources.", + "items": { + "$ref": "#/definitions/ResourceCollectionValueItem" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "ResourceCollectionValueItem": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ResourceLocationDataContract": { + "type": "object", + "description": "Resource location data properties.", + "properties": { + "name": { + "type": "string", + "description": "A canonical name for the geographic or physical location.", + "maxLength": 256 + }, + "city": { + "type": "string", + "description": "The city or locality where the resource is located.", + "maxLength": 256 + }, + "district": { + "type": "string", + "description": "The district, state, or province where the resource is located.", + "maxLength": 256 + }, + "countryOrRegion": { + "type": "string", + "description": "The country or region where the resource is located.", + "maxLength": 256 + } + }, + "required": [ + "name" + ] + }, + "ResourceSku": { + "type": "object", + "description": "Describes an available API Management SKU.", + "properties": { + "name": { + "$ref": "#/definitions/SkuType", + "description": "Name of the Sku." + } + } + }, + "ResourceSkuCapacity": { + "type": "object", + "description": "Describes scaling information of a SKU.", + "properties": { + "minimum": { + "type": "integer", + "format": "int32", + "description": "The minimum capacity.", + "readOnly": true + }, + "maximum": { + "type": "integer", + "format": "int32", + "description": "The maximum capacity that can be set.", + "readOnly": true + }, + "default": { + "type": "integer", + "format": "int32", + "description": "The default capacity.", + "readOnly": true + }, + "scaleType": { + "$ref": "#/definitions/ResourceSkuCapacityScaleType", + "description": "The scale type applicable to the sku.", + "readOnly": true + } + } + }, + "ResourceSkuCapacityScaleType": { + "type": "string", + "description": "The scale type applicable to the sku.", + "enum": [ + "automatic", + "manual", + "none" + ], + "x-ms-enum": { + "name": "ResourceSkuCapacityScaleType", + "modelAsString": true, + "values": [ + { + "name": "automatic", + "value": "automatic", + "description": "Supported scale type automatic." + }, + { + "name": "manual", + "value": "manual", + "description": "Supported scale type manual." + }, + { + "name": "none", + "value": "none", + "description": "Scaling not supported." + } + ] + } + }, + "ResourceSkuResult": { + "type": "object", + "description": "Describes an available API Management service SKU.", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource the SKU applies to.", + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "Specifies API Management SKU.", + "readOnly": true + }, + "capacity": { + "$ref": "#/definitions/ResourceSkuCapacity", + "description": "Specifies the number of API Management units.", + "readOnly": true + } + } + }, + "ResourceSkuResults": { + "type": "object", + "description": "The API Management service SKUs operation response.", + "properties": { + "value": { + "type": "array", + "description": "The list of skus available for the service.", + "items": { + "$ref": "#/definitions/ResourceSkuResult" + }, + "x-ms-identifiers": [ + "resourceType", + "sku/name" + ] + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of API Management service Skus." + } + }, + "required": [ + "value" + ] + }, + "ResponseContract": { + "type": "object", + "description": "Operation response details.", + "properties": { + "statusCode": { + "type": "integer", + "format": "int32", + "description": "Operation response HTTP status code." + }, + "description": { + "type": "string", + "description": "Operation response description." + }, + "representations": { + "type": "array", + "description": "Collection of operation response representations.", + "items": { + "$ref": "#/definitions/RepresentationContract" + }, + "x-ms-identifiers": [] + }, + "headers": { + "type": "array", + "description": "Collection of operation response headers.", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + } + }, + "required": [ + "statusCode" + ] + }, + "SamplingSettings": { + "type": "object", + "description": "Sampling settings for Diagnostic.", + "properties": { + "samplingType": { + "$ref": "#/definitions/SamplingType", + "description": "Sampling type." + }, + "percentage": { + "type": "number", + "format": "double", + "description": "Rate of sampling for fixed-rate sampling.", + "minimum": 0, + "maximum": 100 + } + } + }, + "SamplingType": { + "type": "string", + "description": "Sampling type.", + "enum": [ + "fixed" + ], + "x-ms-enum": { + "name": "SamplingType", + "modelAsString": true, + "values": [ + { + "name": "fixed", + "value": "fixed", + "description": "Fixed-rate sampling." + } + ] + } + }, + "SaveConfigurationParameter": { + "type": "object", + "description": "Save Tenant Configuration Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/SaveConfigurationParameterProperties", + "description": "Properties of the Save Configuration Parameters.", + "x-ms-client-flatten": true + } + } + }, + "SaveConfigurationParameterProperties": { + "type": "object", + "description": "Parameters supplied to the Save Tenant Configuration operation.", + "properties": { + "branch": { + "type": "string", + "description": "The name of the Git branch in which to commit the current configuration snapshot." + }, + "force": { + "type": "boolean", + "description": "The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten." + } + }, + "required": [ + "branch" + ] + }, + "SchemaCollection": { + "type": "object", + "description": "The response of the list schema operation.", + "properties": { + "value": { + "type": "array", + "description": "API Schema Contract value.", + "items": { + "$ref": "#/definitions/SchemaContract" + }, + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "SchemaContract": { + "type": "object", + "description": "API Schema Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/SchemaContractProperties", + "description": "Properties of the API Schema.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SchemaContractProperties": { + "type": "object", + "description": "API Schema create or update contract Properties.", + "properties": { + "contentType": { + "type": "string", + "description": "Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json`
- `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml`
- `OpenApi` Schema use `application/vnd.oai.openapi.components+json`
- `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`
- `OData Schema` use `application/vnd.ms-azure-apim.odata.schema`
- `gRPC Schema` use `text/protobuf`." + }, + "document": { + "$ref": "#/definitions/SchemaDocumentProperties", + "description": "Create or update Properties of the API Schema Document.", + "x-ms-client-flatten": true + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state", + "readOnly": true + } + }, + "required": [ + "contentType", + "document" + ] + }, + "SchemaDocumentProperties": { + "type": "object", + "description": "Api Schema Document Properties.", + "properties": { + "value": { + "type": "string", + "description": "Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI." + }, + "definitions": { + "description": "Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise." + }, + "components": { + "description": "Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise." + } + } + }, + "SchemaType": { + "type": "string", + "description": "Schema Type. Immutable.", + "enum": [ + "xml", + "json" + ], + "x-ms-enum": { + "name": "SchemaType", + "modelAsString": true, + "values": [ + { + "name": "Xml", + "value": "xml", + "description": "XML schema type." + }, + { + "name": "Json", + "value": "json", + "description": "Json schema type." + } + ] + } + }, + "SettingsTypeName": { + "type": "string", + "enum": [ + "public" + ], + "x-ms-enum": { + "name": "SettingsTypeName", + "modelAsString": true, + "values": [ + { + "name": "public", + "value": "public" + } + ] + } + }, + "Severity": { + "type": "string", + "description": "The severity of the issue.", + "enum": [ + "Error", + "Warning" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": true, + "values": [ + { + "name": "Error", + "value": "Error" + }, + { + "name": "Warning", + "value": "Warning" + } + ] + } + }, + "SkuType": { + "type": "string", + "description": "Name of the Sku.", + "enum": [ + "Developer", + "Standard", + "Premium", + "Basic", + "Consumption", + "Isolated", + "BasicV2", + "StandardV2" + ], + "x-ms-enum": { + "name": "SkuType", + "modelAsString": true, + "values": [ + { + "name": "Developer", + "value": "Developer", + "description": "Developer SKU of Api Management." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard SKU of Api Management." + }, + { + "name": "Premium", + "value": "Premium", + "description": "Premium SKU of Api Management." + }, + { + "name": "Basic", + "value": "Basic", + "description": "Basic SKU of Api Management." + }, + { + "name": "Consumption", + "value": "Consumption", + "description": "Consumption SKU of Api Management." + }, + { + "name": "Isolated", + "value": "Isolated", + "description": "Isolated SKU of Api Management." + }, + { + "name": "BasicV2", + "value": "BasicV2", + "description": "BasicV2 SKU of Api Management." + }, + { + "name": "StandardV2", + "value": "StandardV2", + "description": "StandardV2 SKU of Api Management." + } + ] + } + }, + "SoapApiType": { + "type": "string", + "description": "Type of API to create.\n* `http` creates a REST API\n* `soap` creates a SOAP pass-through API\n* `websocket` creates websocket API\n* `graphql` creates GraphQL API.\nNew types can be added in the future.", + "enum": [ + "http", + "soap", + "websocket", + "graphql", + "odata", + "grpc" + ], + "x-ms-enum": { + "name": "SoapApiType", + "modelAsString": true, + "values": [ + { + "name": "SoapToRest", + "value": "http", + "description": "Imports a SOAP API having a RESTful front end." + }, + { + "name": "SoapPassThrough", + "value": "soap", + "description": "Imports the SOAP API having a SOAP front end." + }, + { + "name": "WebSocket", + "value": "websocket", + "description": "Imports the API having a Websocket front end." + }, + { + "name": "GraphQL", + "value": "graphql", + "description": "Imports the API having a GraphQL front end." + }, + { + "name": "OData", + "value": "odata", + "description": "Imports the API having a OData front end." + }, + { + "name": "gRPC", + "value": "grpc", + "description": "Imports the API having a gRPC front end." + } + ] + } + }, + "State": { + "type": "string", + "description": "Status of the issue.", + "enum": [ + "proposed", + "open", + "removed", + "resolved", + "closed" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true, + "values": [ + { + "name": "proposed", + "value": "proposed", + "description": "The issue is proposed." + }, + { + "name": "open", + "value": "open", + "description": "The issue is opened." + }, + { + "name": "removed", + "value": "removed", + "description": "The issue was removed." + }, + { + "name": "resolved", + "value": "resolved", + "description": "The issue is now resolved." + }, + { + "name": "closed", + "value": "closed", + "description": "The issue was closed." + } + ] + } + }, + "SubscriptionCollection": { + "type": "object", + "description": "Paged Subscriptions list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/SubscriptionContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "SubscriptionContract": { + "type": "object", + "description": "Subscription details.", + "properties": { + "properties": { + "$ref": "#/definitions/SubscriptionContractProperties", + "description": "Subscription contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SubscriptionContractProperties": { + "type": "object", + "description": "Subscription details.", + "properties": { + "ownerId": { + "type": "string", + "description": "The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier." + }, + "scope": { + "type": "string", + "description": "Scope like /products/{productId} or /apis or /apis/{apiId}." + }, + "displayName": { + "type": "string", + "description": "The name of the subscription, or null if the subscription has no name.", + "minLength": 0, + "maxLength": 100 + }, + "state": { + "$ref": "#/definitions/SubscriptionState", + "description": "Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated." + }, + "createdDate": { + "type": "string", + "format": "date-time", + "description": "Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.", + "readOnly": true + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "notificationDate": { + "type": "string", + "format": "date-time", + "description": "Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "primaryKey": { + "type": "string", + "format": "password", + "description": "Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "minLength": 1, + "maxLength": 256, + "x-ms-secret": true + }, + "secondaryKey": { + "type": "string", + "format": "password", + "description": "Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.", + "minLength": 1, + "maxLength": 256, + "x-ms-secret": true + }, + "stateComment": { + "type": "string", + "description": "Optional subscription comment added by an administrator when the state is changed to the 'rejected'." + }, + "allowTracing": { + "type": "boolean", + "description": "Determines whether tracing is enabled" + } + }, + "required": [ + "scope", + "state" + ] + }, + "SubscriptionCreateParameterProperties": { + "type": "object", + "description": "Parameters supplied to the Create subscription operation.", + "properties": { + "ownerId": { + "type": "string", + "description": "User (user id path) for whom subscription is being created in form /users/{userId}" + }, + "scope": { + "type": "string", + "description": "Scope like /products/{productId} or /apis or /apis/{apiId}." + }, + "displayName": { + "type": "string", + "description": "Subscription name.", + "minLength": 1, + "maxLength": 100 + }, + "primaryKey": { + "type": "string", + "description": "Primary subscription key. If not specified during request key will be generated automatically.", + "minLength": 1, + "maxLength": 256 + }, + "secondaryKey": { + "type": "string", + "description": "Secondary subscription key. If not specified during request key will be generated automatically.", + "minLength": 1, + "maxLength": 256 + }, + "state": { + "$ref": "#/definitions/SubscriptionState", + "description": "Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated." + }, + "allowTracing": { + "type": "boolean", + "description": "Determines whether tracing can be enabled" + } + }, + "required": [ + "scope", + "displayName" + ] + }, + "SubscriptionCreateParameters": { + "type": "object", + "description": "Subscription create details.", + "properties": { + "properties": { + "$ref": "#/definitions/SubscriptionCreateParameterProperties", + "description": "Subscription contract properties.", + "x-ms-client-flatten": true + } + } + }, + "SubscriptionKeyParameterNamesContract": { + "type": "object", + "description": "Subscription key parameter names details.", + "properties": { + "header": { + "type": "string", + "description": "Subscription key header name." + }, + "query": { + "type": "string", + "description": "Subscription key query string parameter name." + } + } + }, + "SubscriptionKeysContract": { + "type": "object", + "description": "Subscription keys.", + "properties": { + "primaryKey": { + "type": "string", + "description": "Subscription primary key.", + "minLength": 1, + "maxLength": 256 + }, + "secondaryKey": { + "type": "string", + "description": "Subscription secondary key.", + "minLength": 1, + "maxLength": 256 + } + } + }, + "SubscriptionState": { + "type": "string", + "description": "Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.", + "enum": [ + "suspended", + "active", + "expired", + "submitted", + "rejected", + "cancelled" + ], + "x-ms-enum": { + "name": "SubscriptionState", + "modelAsString": false + } + }, + "SubscriptionUpdateParameterProperties": { + "type": "object", + "description": "Parameters supplied to the Update subscription operation.", + "properties": { + "ownerId": { + "type": "string", + "description": "User identifier path: /users/{userId}" + }, + "scope": { + "type": "string", + "description": "Scope like /products/{productId} or /apis or /apis/{apiId}" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "displayName": { + "type": "string", + "description": "Subscription name." + }, + "primaryKey": { + "type": "string", + "description": "Primary subscription key.", + "minLength": 1, + "maxLength": 256 + }, + "secondaryKey": { + "type": "string", + "description": "Secondary subscription key.", + "minLength": 1, + "maxLength": 256 + }, + "state": { + "$ref": "#/definitions/SubscriptionState", + "description": "Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated." + }, + "stateComment": { + "type": "string", + "description": "Comments describing subscription state change by the administrator when the state is changed to the 'rejected'." + }, + "allowTracing": { + "type": "boolean", + "description": "Determines whether tracing can be enabled" + } + } + }, + "SubscriptionUpdateParameters": { + "type": "object", + "description": "Subscription update details.", + "properties": { + "properties": { + "$ref": "#/definitions/SubscriptionUpdateParameterProperties", + "description": "Subscription Update contract properties.", + "x-ms-client-flatten": true + } + } + }, + "SubscriptionsDelegationSettingsProperties": { + "type": "object", + "description": "Subscriptions delegation settings properties.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable or disable delegation for subscriptions." + } + } + }, + "TagApiLinkCollection": { + "type": "object", + "description": "Paged Tag-API link list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/TagApiLinkContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "TagApiLinkContract": { + "type": "object", + "description": "Tag-API link details.", + "properties": { + "properties": { + "$ref": "#/definitions/TagApiLinkContractProperties", + "description": "Tag-API link entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "TagApiLinkContractProperties": { + "type": "object", + "description": "Tag-API link entity properties.", + "properties": { + "apiId": { + "type": "string", + "description": "Full resource Id of an API." + } + }, + "required": [ + "apiId" + ] + }, + "TagCollection": { + "type": "object", + "description": "Paged Tag list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/TagContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "TagContract": { + "type": "object", + "description": "Tag Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/TagContractProperties", + "description": "Tag entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "TagContractProperties": { + "type": "object", + "description": "Tag contract Properties.", + "properties": { + "displayName": { + "type": "string", + "description": "Tag name.", + "minLength": 1, + "maxLength": 160 + } + }, + "required": [ + "displayName" + ] + }, + "TagCreateUpdateParameters": { + "type": "object", + "description": "Parameters supplied to Create/Update Tag operations.", + "properties": { + "properties": { + "$ref": "#/definitions/TagContractProperties", + "description": "Properties supplied to Create Tag operation.", + "x-ms-client-flatten": true + } + } + }, + "TagDescriptionBaseProperties": { + "type": "object", + "description": "Parameters supplied to the Create TagDescription operation.", + "properties": { + "description": { + "type": "string", + "description": "Description of the Tag." + }, + "externalDocsUrl": { + "type": "string", + "description": "Absolute URL of external resources describing the tag.", + "maxLength": 2000 + }, + "externalDocsDescription": { + "type": "string", + "description": "Description of the external resources describing the tag." + } + } + }, + "TagDescriptionCollection": { + "type": "object", + "description": "Paged TagDescription list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/TagDescriptionContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "TagDescriptionContract": { + "type": "object", + "description": "Contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/TagDescriptionContractProperties", + "description": "TagDescription entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "TagDescriptionContractProperties": { + "type": "object", + "description": "TagDescription contract Properties.", + "properties": { + "tagId": { + "type": "string", + "description": "Identifier of the tag in the form of /tags/{tagId}" + }, + "displayName": { + "type": "string", + "description": "Tag name.", + "minLength": 1, + "maxLength": 160 + } + }, + "allOf": [ + { + "$ref": "#/definitions/TagDescriptionBaseProperties" + } + ] + }, + "TagDescriptionCreateParameters": { + "type": "object", + "description": "Parameters supplied to the Create TagDescription operation.", + "properties": { + "properties": { + "$ref": "#/definitions/TagDescriptionBaseProperties", + "description": "Properties supplied to Create TagDescription operation.", + "x-ms-client-flatten": true + } + } + }, + "TagOperationLinkCollection": { + "type": "object", + "description": "Paged Tag-operation link list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/TagOperationLinkContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "TagOperationLinkContract": { + "type": "object", + "description": "Tag-operation link details.", + "properties": { + "properties": { + "$ref": "#/definitions/TagOperationLinkContractProperties", + "description": "Tag-API link entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "TagOperationLinkContractProperties": { + "type": "object", + "description": "Tag-operation link entity properties.", + "properties": { + "operationId": { + "type": "string", + "description": "Full resource Id of an API operation." + } + }, + "required": [ + "operationId" + ] + }, + "TagProductLinkCollection": { + "type": "object", + "description": "Paged Tag-product link list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/TagProductLinkContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "TagProductLinkContract": { + "type": "object", + "description": "Tag-product link details.", + "properties": { + "properties": { + "$ref": "#/definitions/TagProductLinkContractProperties", + "description": "Tag-API link entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "TagProductLinkContractProperties": { + "type": "object", + "description": "Tag-product link entity properties.", + "properties": { + "productId": { + "type": "string", + "description": "Full resource Id of a product." + } + }, + "required": [ + "productId" + ] + }, + "TagResourceCollection": { + "type": "object", + "description": "Paged Tag list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/TagResourceContract" + }, + "x-ms-identifiers": [ + "tag/id" + ] + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "TagResourceContract": { + "type": "object", + "description": "TagResource contract properties.", + "properties": { + "tag": { + "$ref": "#/definitions/TagTagResourceContractProperties", + "description": "Tag associated with the resource." + }, + "api": { + "$ref": "#/definitions/ApiTagResourceContractProperties", + "description": "API associated with the tag." + }, + "operation": { + "$ref": "#/definitions/OperationTagResourceContractProperties", + "description": "Operation associated with the tag." + }, + "product": { + "$ref": "#/definitions/ProductTagResourceContractProperties", + "description": "Product associated with the tag." + } + }, + "required": [ + "tag" + ] + }, + "TagTagResourceContractProperties": { + "type": "object", + "description": "Contract defining the Tag property in the Tag Resource Contract", + "properties": { + "id": { + "type": "string", + "description": "Tag identifier" + }, + "name": { + "type": "string", + "description": "Tag Name", + "minLength": 1, + "maxLength": 160 + } + } + }, + "TemplateName": { + "type": "string", + "enum": [ + "applicationApprovedNotificationMessage", + "accountClosedDeveloper", + "quotaLimitApproachingDeveloperNotificationMessage", + "newDeveloperNotificationMessage", + "emailChangeIdentityDefault", + "inviteUserNotificationMessage", + "newCommentNotificationMessage", + "confirmSignUpIdentityDefault", + "newIssueNotificationMessage", + "purchaseDeveloperNotificationMessage", + "passwordResetIdentityDefault", + "passwordResetByAdminNotificationMessage", + "rejectDeveloperNotificationMessage", + "requestDeveloperNotificationMessage" + ], + "x-ms-enum": { + "name": "TemplateName", + "modelAsString": true, + "values": [ + { + "name": "applicationApprovedNotificationMessage", + "value": "applicationApprovedNotificationMessage" + }, + { + "name": "accountClosedDeveloper", + "value": "accountClosedDeveloper" + }, + { + "name": "quotaLimitApproachingDeveloperNotificationMessage", + "value": "quotaLimitApproachingDeveloperNotificationMessage" + }, + { + "name": "newDeveloperNotificationMessage", + "value": "newDeveloperNotificationMessage" + }, + { + "name": "emailChangeIdentityDefault", + "value": "emailChangeIdentityDefault" + }, + { + "name": "inviteUserNotificationMessage", + "value": "inviteUserNotificationMessage" + }, + { + "name": "newCommentNotificationMessage", + "value": "newCommentNotificationMessage" + }, + { + "name": "confirmSignUpIdentityDefault", + "value": "confirmSignUpIdentityDefault" + }, + { + "name": "newIssueNotificationMessage", + "value": "newIssueNotificationMessage" + }, + { + "name": "purchaseDeveloperNotificationMessage", + "value": "purchaseDeveloperNotificationMessage" + }, + { + "name": "passwordResetIdentityDefault", + "value": "passwordResetIdentityDefault" + }, + { + "name": "passwordResetByAdminNotificationMessage", + "value": "passwordResetByAdminNotificationMessage" + }, + { + "name": "rejectDeveloperNotificationMessage", + "value": "rejectDeveloperNotificationMessage" + }, + { + "name": "requestDeveloperNotificationMessage", + "value": "requestDeveloperNotificationMessage" + } + ] + } + }, + "TenantConfigurationSyncStateContract": { + "type": "object", + "description": "Result of Tenant Configuration Sync State.", + "properties": { + "properties": { + "$ref": "#/definitions/TenantConfigurationSyncStateContractProperties", + "description": "Properties returned Tenant Configuration Sync State check.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "TenantConfigurationSyncStateContractProperties": { + "type": "object", + "description": "Tenant Configuration Synchronization State.", + "properties": { + "branch": { + "type": "string", + "description": "The name of Git branch." + }, + "commitId": { + "type": "string", + "description": "The latest commit Id." + }, + "isExport": { + "type": "boolean", + "description": "value indicating if last sync was save (true) or deploy (false) operation." + }, + "isSynced": { + "type": "boolean", + "description": "value indicating if last synchronization was later than the configuration change." + }, + "isGitEnabled": { + "type": "boolean", + "description": "value indicating whether Git configuration access is enabled." + }, + "syncDate": { + "type": "string", + "format": "date-time", + "description": "The date of the latest synchronization. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "configurationChangeDate": { + "type": "string", + "format": "date-time", + "description": "The date of the latest configuration change. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "lastOperationId": { + "type": "string", + "description": "Most recent tenant configuration operation identifier" + } + } + }, + "TenantSettingsCollection": { + "type": "object", + "description": "Paged AccessInformation list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/TenantSettingsContract" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "TenantSettingsContract": { + "type": "object", + "description": "Tenant Settings.", + "properties": { + "properties": { + "$ref": "#/definitions/TenantSettingsContractProperties", + "description": "TenantSettings entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "TenantSettingsContractProperties": { + "type": "object", + "description": "Tenant access information contract of the API Management service.", + "properties": { + "settings": { + "type": "object", + "description": "Tenant settings", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TermsOfServiceProperties": { + "type": "object", + "description": "Terms of service contract properties.", + "properties": { + "text": { + "type": "string", + "description": "A terms of service text." + }, + "enabled": { + "type": "boolean", + "description": "Display terms of service during a sign-up process." + }, + "consentRequired": { + "type": "boolean", + "description": "Ask user for consent to the terms of service." + } + } + }, + "TokenBodyParameterContract": { + "type": "object", + "description": "OAuth acquire token request body parameter (www-url-form-encoded).", + "properties": { + "name": { + "type": "string", + "description": "body parameter name." + }, + "value": { + "type": "string", + "description": "body parameter value." + } + }, + "required": [ + "name", + "value" + ] + }, + "TranslateRequiredQueryParametersConduct": { + "type": "string", + "description": "Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'", + "enum": [ + "template", + "query" + ], + "x-ms-enum": { + "name": "TranslateRequiredQueryParametersConduct", + "modelAsString": true, + "values": [ + { + "name": "Template", + "value": "template", + "description": "Translates required query parameters to template ones. Is a default value" + }, + { + "name": "Query", + "value": "query", + "description": "Leaves required query parameters as they are (no translation done)." + } + ] + } + }, + "UserCollection": { + "type": "object", + "description": "Paged Users list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/UserContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "UserContract": { + "type": "object", + "description": "User details.", + "properties": { + "properties": { + "$ref": "#/definitions/UserContractProperties", + "description": "User entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "UserContractProperties": { + "type": "object", + "description": "User profile.", + "properties": { + "firstName": { + "type": "string", + "description": "First name." + }, + "lastName": { + "type": "string", + "description": "Last name." + }, + "email": { + "type": "string", + "description": "Email address." + }, + "registrationDate": { + "type": "string", + "format": "date-time", + "description": "Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "groups": { + "type": "array", + "description": "Collection of groups user is part of.", + "items": { + "$ref": "#/definitions/GroupContractProperties" + }, + "readOnly": true, + "x-ms-identifiers": [ + "displayName" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/UserEntityBaseParameters" + } + ] + }, + "UserCreateParameterProperties": { + "type": "object", + "description": "Parameters supplied to the Create User operation.", + "properties": { + "email": { + "type": "string", + "description": "Email address. Must not be empty and must be unique within the service instance.", + "minLength": 1, + "maxLength": 254 + }, + "firstName": { + "type": "string", + "description": "First name.", + "minLength": 1, + "maxLength": 100 + }, + "lastName": { + "type": "string", + "description": "Last name.", + "minLength": 1, + "maxLength": 100 + }, + "password": { + "type": "string", + "description": "User Password. If no value is provided, a default password is generated." + }, + "appType": { + "$ref": "#/definitions/AppType", + "description": "Determines the type of application which send the create user request. Default is legacy portal." + }, + "confirmation": { + "$ref": "#/definitions/Confirmation", + "description": "Determines the type of confirmation e-mail that will be sent to the newly created user." + } + }, + "required": [ + "email", + "firstName", + "lastName" + ], + "allOf": [ + { + "$ref": "#/definitions/UserEntityBaseParameters" + } + ] + }, + "UserCreateParameters": { + "type": "object", + "description": "User create details.", + "properties": { + "properties": { + "$ref": "#/definitions/UserCreateParameterProperties", + "description": "User entity create contract properties.", + "x-ms-client-flatten": true + } + } + }, + "UserEntityBaseParameters": { + "type": "object", + "description": "User Entity Base Parameters set.", + "properties": { + "state": { + "type": "string", + "description": "Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.", + "default": "active", + "enum": [ + "active", + "blocked", + "pending", + "deleted" + ], + "x-ms-enum": { + "name": "UserState", + "modelAsString": true, + "values": [ + { + "name": "active", + "value": "active", + "description": "User state is active." + }, + { + "name": "blocked", + "value": "blocked", + "description": "User is blocked. Blocked users cannot authenticate at developer portal or call API." + }, + { + "name": "pending", + "value": "pending", + "description": "User account is pending. Requires identity confirmation before it can be made active." + }, + { + "name": "deleted", + "value": "deleted", + "description": "User account is closed. All identities and related entities are removed." + } + ] + } + }, + "note": { + "type": "string", + "description": "Optional note about a user set by the administrator." + }, + "identities": { + "type": "array", + "description": "Collection of user identities.", + "items": { + "$ref": "#/definitions/UserIdentityContract" + } + } + } + }, + "UserIdentityCollection": { + "type": "object", + "description": "List of Users Identity list representation.", + "properties": { + "value": { + "type": "array", + "description": "User Identity values.", + "items": { + "$ref": "#/definitions/UserIdentityContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "UserIdentityContract": { + "type": "object", + "description": "User identity details.", + "properties": { + "provider": { + "type": "string", + "description": "Identity provider name." + }, + "id": { + "type": "string", + "description": "Identifier value within provider." + } + } + }, + "UserIdentityProperties": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "UserState": { + "type": "string", + "description": "Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.", + "enum": [ + "active", + "blocked", + "pending", + "deleted" + ], + "x-ms-enum": { + "name": "UserState", + "modelAsString": true, + "values": [ + { + "name": "active", + "value": "active", + "description": "User state is active." + }, + { + "name": "blocked", + "value": "blocked", + "description": "User is blocked. Blocked users cannot authenticate at developer portal or call API." + }, + { + "name": "pending", + "value": "pending", + "description": "User account is pending. Requires identity confirmation before it can be made active." + }, + { + "name": "deleted", + "value": "deleted", + "description": "User account is closed. All identities and related entities are removed." + } + ] + } + }, + "UserTokenParameterProperties": { + "type": "object", + "description": "Parameters supplied to the Get User Token operation.", + "properties": { + "keyType": { + "type": "string", + "description": "The Key to be used to generate token for user.", + "default": "primary", + "enum": [ + "primary", + "secondary" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "expiry": { + "type": "string", + "format": "date-time", + "description": "The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + } + }, + "required": [ + "keyType", + "expiry" + ] + }, + "UserTokenParameters": { + "type": "object", + "description": "Get User Token parameters.", + "properties": { + "properties": { + "$ref": "#/definitions/UserTokenParameterProperties", + "description": "User Token Parameter contract properties.", + "x-ms-client-flatten": true + } + } + }, + "UserTokenResult": { + "type": "object", + "description": "Get User Token response details.", + "properties": { + "value": { + "type": "string", + "description": "Shared Access Authorization token for the User." + } + } + }, + "UserUpdateParameters": { + "type": "object", + "description": "User update parameters.", + "properties": { + "properties": { + "$ref": "#/definitions/UserUpdateParametersProperties", + "description": "User entity update contract properties.", + "x-ms-client-flatten": true + } + } + }, + "UserUpdateParametersProperties": { + "type": "object", + "description": "Parameters supplied to the Update User operation.", + "properties": { + "email": { + "type": "string", + "description": "Email address. Must not be empty and must be unique within the service instance.", + "minLength": 1, + "maxLength": 254 + }, + "password": { + "type": "string", + "description": "User Password." + }, + "firstName": { + "type": "string", + "description": "First name.", + "minLength": 1, + "maxLength": 100 + }, + "lastName": { + "type": "string", + "description": "Last name.", + "minLength": 1, + "maxLength": 100 + } + }, + "allOf": [ + { + "$ref": "#/definitions/UserEntityBaseParameters" + } + ] + }, + "Verbosity": { + "type": "string", + "description": "The verbosity level applied to traces emitted by trace policies.", + "enum": [ + "verbose", + "information", + "error" + ], + "x-ms-enum": { + "name": "Verbosity", + "modelAsString": true, + "values": [ + { + "name": "verbose", + "value": "verbose", + "description": "All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance." + }, + { + "name": "information", + "value": "information", + "description": "Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance." + }, + { + "name": "error", + "value": "error", + "description": "Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance." + } + ] + } + }, + "VersioningScheme": { + "type": "string", + "description": "An value that determines where the API Version identifier will be located in a HTTP request.", + "enum": [ + "Segment", + "Query", + "Header" + ], + "x-ms-enum": { + "name": "VersioningScheme", + "modelAsString": true, + "values": [ + { + "name": "Segment", + "value": "Segment", + "description": "The API Version is passed in a path segment." + }, + { + "name": "Query", + "value": "Query", + "description": "The API Version is passed in a query parameter." + }, + { + "name": "Header", + "value": "Header", + "description": "The API Version is passed in a HTTP header." + } + ] + } + }, + "VirtualNetworkConfiguration": { + "type": "object", + "description": "Configuration of a virtual network to which API Management service is deployed.", + "properties": { + "vnetid": { + "type": "string", + "description": "The virtual network ID. This is typically a GUID. Expect a null GUID by default.", + "readOnly": true + }, + "subnetname": { + "type": "string", + "description": "The name of the subnet.", + "readOnly": true + }, + "subnetResourceId": { + "type": "string", + "description": "The full resource ID of a subnet in a virtual network to deploy the API Management service in.", + "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$" + } + } + }, + "VirtualNetworkType": { + "type": "string", + "description": "The type of VPN in which API Management gateway needs to be configured in.", + "enum": [ + "None", + "External", + "Internal" + ], + "x-ms-enum": { + "name": "VirtualNetworkType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "The API Management gateway is not part of any Virtual Network." + }, + { + "name": "External", + "value": "External", + "description": "The API Management gateway is part of Virtual Network and it is accessible from Internet." + }, + { + "name": "Internal", + "value": "Internal", + "description": "The API Management gateway is part of Virtual Network and it is only accessible from within the virtual network." + } + ] + } + }, + "WikiCollection": { + "type": "object", + "description": "Paged Wiki list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/WikiContract" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + } + }, + "WikiContract": { + "type": "object", + "description": "Wiki properties", + "properties": { + "properties": { + "$ref": "#/definitions/WikiContractProperties", + "description": "Wiki details.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WikiContractProperties": { + "type": "object", + "description": "Wiki contract details", + "properties": { + "documents": { + "type": "array", + "description": "Collection wiki documents included into this wiki.", + "items": { + "$ref": "#/definitions/WikiDocumentationContract" + }, + "x-ms-identifiers": [ + "documentationId" + ] + } + } + }, + "WikiDocumentationContract": { + "type": "object", + "description": "Wiki documentation details.", + "properties": { + "documentationId": { + "type": "string", + "description": "Documentation Identifier" + } + } + }, + "WikiUpdateContract": { + "type": "object", + "description": "Wiki update contract details.", + "properties": { + "properties": { + "$ref": "#/definitions/WikiContractProperties", + "description": "Wiki details.", + "x-ms-client-flatten": true + } + } + }, + "WorkspaceCollection": { + "type": "object", + "description": "Paged workspace list representation.", + "properties": { + "value": { + "type": "array", + "description": "Page values.", + "items": { + "$ref": "#/definitions/WorkspaceContract" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + } + }, + "WorkspaceContract": { + "type": "object", + "description": "Workspace details.", + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceContractProperties", + "description": "Workspace entity contract properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WorkspaceContractProperties": { + "type": "object", + "description": "Workspace entity properties.", + "properties": { + "displayName": { + "type": "string", + "description": "Name of the workspace." + }, + "description": { + "type": "string", + "description": "Description of the workspace." + } + }, + "required": [ + "displayName" + ] + }, + "WorkspaceLinksBaseProperties": { + "type": "object", + "properties": { + "workspaceId": { + "type": "string", + "format": "arm-id", + "description": "The link to the API Management service workspace.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ApiManagement/service/workspaces" + } + ] + } + }, + "gateways": { + "type": "array", + "description": "The array of linked gateways.", + "items": { + "$ref": "#/definitions/WorkspaceLinksGateway" + } + } + } + }, + "WorkspaceLinksGateway": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The link to the API Management gateway.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ApiManagement/gateways" + } + ] + } + } + } + }, + "X509CertificateName": { + "type": "object", + "description": "Properties of server X509Names.", + "properties": { + "name": { + "type": "string", + "description": "Common Name of the Certificate." + }, + "issuerCertificateThumbprint": { + "type": "string", + "description": "Thumbprint for the Issuer of the Certificate." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-windows-cluster-x509-security" + } + } + }, + "parameters": {} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/operationStatuses.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/operationStatuses.json deleted file mode 100644 index 73ad704b1e97..000000000000 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2024-10-01-preview/operationStatuses.json +++ /dev/null @@ -1,107 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Resource provider operation status.", - "version": "2024-10-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/operationStatuses/{operationId}": { - "get": { - "operationId": "OperationStatus_Get", - "description": "Returns the current status of an async operation.", - "x-ms-examples": { - "Get operation status": { - "$ref": "./examples/ApiManagementGetOperationStatus.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/LocationParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/OperationIdParameter" - } - ], - "responses": { - "200": { - "description": "Requested operation status", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/operationResults/{operationId}": { - "get": { - "tags": [ - "OperationResults" - ], - "description": "Returns operation results for long running operations executing DELETE or PATCH on the resource.", - "operationId": "OperationsResults_Get", - "x-ms-examples": { - "ApiManagementGetOperationResult": { - "$ref": "./examples/ApiManagementGetOperationResult.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/LocationParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/OperationIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the operation result." - }, - "202": { - "description": "The operation is still in progress.", - "headers": { - "Location": { - "type": "string", - "description": "URL for determining when an operation has completed." - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - } - } -} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/readme.md b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/readme.md index 6e8aba94693e..011745f6b1f1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/readme.md +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/readme.md @@ -37,66 +37,7 @@ These settings apply only when `--tag=package-preview-2024-10-01-preview` is spe ```yaml $(tag) == 'package-preview-2024-10-01-preview' input-file: - - preview/2024-10-01-preview/apigateway.json - - preview/2024-10-01-preview/apimallpolicies.json - - preview/2024-10-01-preview/apimanagement.json - - preview/2024-10-01-preview/apimapis.json - - preview/2024-10-01-preview/apimapisByTags.json - - preview/2024-10-01-preview/apimapiversionsets.json - - preview/2024-10-01-preview/apimauthorizationproviders.json - - preview/2024-10-01-preview/apimauthorizationservers.json - - preview/2024-10-01-preview/apimbackends.json - - preview/2024-10-01-preview/apimcaches.json - - preview/2024-10-01-preview/apimcertificates.json - - preview/2024-10-01-preview/apimconnectivitycheck.json - - preview/2024-10-01-preview/apimcontenttypes.json - - preview/2024-10-01-preview/apimdeletedservices.json - - preview/2024-10-01-preview/apimdeployment.json - - preview/2024-10-01-preview/apimdiagnostics.json - - preview/2024-10-01-preview/apimdocumentations.json - - preview/2024-10-01-preview/apimemailtemplates.json - - preview/2024-10-01-preview/apimgatewayConfigConnections.json - - preview/2024-10-01-preview/apimgateways.json - - preview/2024-10-01-preview/apimgroups.json - - preview/2024-10-01-preview/apimidentityprovider.json - - preview/2024-10-01-preview/apimissues.json - - preview/2024-10-01-preview/apimloggers.json - - preview/2024-10-01-preview/apimnamedvalues.json - - preview/2024-10-01-preview/apimnetworkstatus.json - - preview/2024-10-01-preview/apimnotifications.json - - preview/2024-10-01-preview/apimopenidconnectproviders.json - - preview/2024-10-01-preview/apimoutbounddependency.json - - preview/2024-10-01-preview/apimpolicies.json - - preview/2024-10-01-preview/apimpolicydescriptions.json - - preview/2024-10-01-preview/apimpolicyfragments.json - - preview/2024-10-01-preview/apimpolicyrestrictions.json - - preview/2024-10-01-preview/apimpolicyrestrictionsvalidation.json - - preview/2024-10-01-preview/apimportalconfigs.json - - preview/2024-10-01-preview/apimclientApplications.json - - preview/2024-10-01-preview/apimportalrevisions.json - - preview/2024-10-01-preview/apimportalsettings.json - - preview/2024-10-01-preview/apimprivatelink.json - - preview/2024-10-01-preview/apimproducts.json - - preview/2024-10-01-preview/apimproductsByTags.json - - preview/2024-10-01-preview/apimquotas.json - - preview/2024-10-01-preview/apimregions.json - - preview/2024-10-01-preview/apimreports.json - - preview/2024-10-01-preview/apimschema.json - - preview/2024-10-01-preview/apimsettings.json - - preview/2024-10-01-preview/apimskus.json - - preview/2024-10-01-preview/apimsubscriptions.json - - preview/2024-10-01-preview/apimtagresources.json - - preview/2024-10-01-preview/apimtags.json - - preview/2024-10-01-preview/apimtenant.json - - preview/2024-10-01-preview/apimusers.json - - preview/2024-10-01-preview/apimworkspacebackends.json - - preview/2024-10-01-preview/apimworkspacecertificates.json - - preview/2024-10-01-preview/apimworkspacediagnostics.json - - preview/2024-10-01-preview/apimworkspacelinks.json - - preview/2024-10-01-preview/apimworkspaceloggers.json - - preview/2024-10-01-preview/apimworkspaces.json - - preview/2024-10-01-preview/definitions.json - - preview/2024-10-01-preview/operationStatuses.json + - preview/2024-10-01-preview/openapi.json ``` ### Tag: package-preview-2024-06 diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/routes.tsp b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/routes.tsp new file mode 100644 index 000000000000..93973599ec05 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/routes.tsp @@ -0,0 +1,217 @@ +// FIXME: Operations in this file are not detected as a resource operation, please confirm the conversion result manually + +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "./models.tsp"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; +using TypeSpec.OpenAPI; + +namespace Microsoft.ApiManagement; + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface ApiExportOperationGroup { + /** + * Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes. + */ + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?export=true") + @get + get( + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + + /** + * The name of the API Management service. + */ + @maxLength(50) + @minLength(1) + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @path + serviceName: string, + + /** + * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. + */ + @maxLength(256) + @minLength(1) + @pattern("^[^*#&+:<>?]+$") + @path + apiId: string, + + /** + * Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes. New formats can be added in the future. + */ + @query("format") + format: ExportFormat, + + /** + * Query parameter required to export the API details. + */ + @query("export") + export: ExportApi, + ): ArmResponse | ErrorResponse; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface DeletedServicesOperationGroup { + /** + * Lists all soft-deleted services available for undelete for the given subscription. + */ + @autoRoute + @get + @action("deletedservices") + @list + listBySubscription is ArmProviderActionSync< + Response = DeletedServicesCollection, + Scope = SubscriptionActionScope, + Parameters = {} + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface ApiManagementServiceOperationGroup { + /** + * Checks availability and correctness of a name for an API Management service. + */ + @autoRoute + checkNameAvailability is ArmProviderActionSync< + Request = ApiManagementServiceCheckNameAvailabilityParameters, + Response = ApiManagementServiceNameAvailabilityResult, + Scope = SubscriptionActionScope, + Parameters = {} + >; + /** + * Get the custom domain ownership identifier for an API Management service. + */ + @autoRoute + getDomainOwnershipIdentifier is ArmProviderActionSync< + Response = ApiManagementServiceGetDomainOwnershipIdentifierResult, + Scope = SubscriptionActionScope, + Parameters = {} + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface ApiManagementSkusOperationGroup { + /** + * Gets the list of Microsoft.ApiManagement SKUs available for your Subscription. + */ + @autoRoute + @get + @action("skus") + @list + list is ArmProviderActionSync< + Response = ArmResponse, + Scope = SubscriptionActionScope, + Parameters = {} + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface WorkspaceApiExportOperationGroup { + /** + * Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes. + */ + @route("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}?export=true") + @get + get( + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...ResourceGroupParameter, + + /** + * The name of the API Management service. + */ + @maxLength(50) + @minLength(1) + @pattern("^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$") + @path + serviceName: string, + + /** + * Workspace identifier. Must be unique in the current API Management service instance. + */ + @maxLength(80) + @minLength(1) + @pattern("^[^*#&+:<>?]+$") + @path + workspaceId: string, + + /** + * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. + */ + @maxLength(256) + @minLength(1) + @pattern("^[^*#&+:<>?]+$") + @path + apiId: string, + + /** + * Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes. + */ + @query("format") + format: ExportFormat, + + /** + * Query parameter required to export the API details. + */ + @query("export") + export: ExportApi, + ): ArmResponse | ErrorResponse; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface OperationStatusOperationGroup { + /** + * Returns the current status of an async operation. + */ + @route("/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/operationStatuses/{operationId}") + @get + get( + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...LocationResourceParameter, + + /** + * The ID of an ongoing async operation. + */ + @path + @minLength(1) + @maxLength(80) + operationId: string, + ): ArmResponse | ErrorResponse; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface OperationsResultsOperationGroup { + /** + * Returns operation results for long running operations executing DELETE or PATCH on the resource. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/no-response-body" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @route("/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/operationResults/{operationId}") + @get + get( + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...LocationResourceParameter, + + /** + * The ID of an ongoing async operation. + */ + @path + @minLength(1) + @maxLength(80) + operationId: string, + ): OkResponse | (ArmAcceptedResponse & { + /** + * URL for determining when an operation has completed. + **/ + @header("Location") + location: string; + }) | ErrorResponse; +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/suppressions.yaml b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/suppressions.yaml index b26a713a6f1c..559b11af8235 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/suppressions.yaml +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/suppressions.yaml @@ -34,9 +34,6 @@ - tool: TypeSpecRequirement path: ./preview/2024-06-01-preview/*.json reason: Brownfield service not ready to migrate -- tool: TypeSpecRequirement - path: ./preview/2024-10-01-preview/*.json - reason: Brownfield service not ready to migrate - tool: TypeSpecRequirement path: ./stable/2016-07-07/*.json reason: Brownfield service not ready to migrate diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/tspconfig.yaml b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/tspconfig.yaml new file mode 100644 index 000000000000..2f957d8a4f6b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/tspconfig.yaml @@ -0,0 +1,51 @@ +parameters: + "service-dir": + default: "sdk/apimanagement" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + emitter-output-dir: "{project-root}" + azure-resource-provider-folder: "resource-manager" + output-file: "{version-status}/{version}/openapi.json" + arm-types-dir: "{project-root}/../../../../common-types/resource-management" + emit-lro-options: "all" + examples-dir: "{project-root}/examples" + arm-resource-flattening: true + "@azure-tools/typespec-csharp": + emitter-output-dir: "{output-dir}/{service-dir}/Azure.ResourceManager.ApiManagement" + clear-output-folder: true + model-namespace: false + namespace: "Azure.ResourceManager.ApiManagement" + flavor: azure + "@azure-tools/typespec-python": + emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-apimanagement" + namespace: "azure.mgmt.apimanagement" + generate-test: true + generate-sample: true + flavor: "azure" + "@azure-tools/typespec-java": + emitter-output-dir: "{output-dir}/{service-dir}/azure-resourcemanager-apimanagement" + namespace: "com.azure.resourcemanager.apimanagement" + service-name: "ApiManagement" + flavor: azure + use-object-for-unknown: true + "@azure-tools/typespec-ts": + emitter-output-dir: "{output-dir}/{service-dir}/arm-apimanagement" + flavor: azure + experimental-extensible-enums: true + package-details: + name: "@azure/arm-apimanagement" + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/apimanagement" + emitter-output-dir: "{output-dir}/{service-dir}/armapimanagement" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/armapimanagement" + fix-const-stuttering: false + flavor: "azure" + generate-samples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager"