diff --git a/custom-words.txt b/custom-words.txt index e9a85a02d393..7af87effcf31 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2287,6 +2287,7 @@ rmpl rmse rolledback rollforward +Rollingback rollouts rolloverdetails rollupby @@ -2568,6 +2569,7 @@ starttask starttaskfailed starttime stateful +statefulset stateset statesets statetile diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/common.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/common.json new file mode 100644 index 000000000000..b9842a83c119 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/common.json @@ -0,0 +1,595 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The definitions in this swagger specification will be used to manage the Hybrid Network resources.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ReferencedResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Reference to another resource.", + "x-ms-azure-resource": true + }, + "CustomLocationResourceId": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\\.[eE][xX][tT][eE][nN][dD][eE][dD][lL][oO][cC][aA][tT][iI][oO][nN]/[cC][uU][sS][tT][oO][mM][lL][oO][cC][aA][tT][iI][oO][nN][sS]/[^/?#]+$", + "description": "Azure ARC custom location resource ID." + } + }, + "description": "Reference to an Azure ARC custom location resource.", + "x-ms-azure-resource": true + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Unknown", + "Succeeded", + "Accepted", + "Deleting", + "Failed", + "Canceled", + "Deleted", + "Converging" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "NetworkFunctionType": { + "type": "string", + "description": "The network function type.", + "enum": [ + "Unknown", + "VirtualNetworkFunction", + "ContainerizedNetworkFunction" + ], + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-enum": { + "name": "NetworkFunctionType", + "modelAsString": true + } + }, + "NFVIType": { + "type": "string", + "description": "The NFVI type.", + "enum": [ + "Unknown", + "AzureArcKubernetes", + "AzureCore", + "AzureOperatorNexus" + ], + "x-ms-enum": { + "name": "NFVIType", + "modelAsString": true + } + }, + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "NetworkFunctionApplication": { + "description": "Network function application definition.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the network function application." + }, + "dependsOnProfile": { + "description": "Depends on profile definition.", + "$ref": "#/definitions/DependsOnProfile" + } + } + }, + "DependsOnProfile": { + "description": "Depends on profile definition.", + "type": "object", + "properties": { + "installDependsOn": { + "type": "array", + "description": "Application installation operation dependency.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "uninstallDependsOn": { + "type": "array", + "description": "Application deletion operation dependency.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "updateDependsOn": { + "type": "array", + "description": "Application update operation dependency.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "ArtifactProfile": { + "description": "Artifact profile properties.", + "type": "object", + "properties": { + "artifactStore": { + "$ref": "#/definitions/ReferencedResource", + "description": "The reference to artifact store." + } + } + }, + "MappingRuleProfile": { + "description": "Mapping rule profile properties.", + "type": "object", + "properties": { + "applicationEnablement": { + "type": "string", + "description": "The application enablement.", + "enum": [ + "Unknown", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ApplicationEnablement", + "modelAsString": true + } + } + } + }, + "GenericParameters": { + "type": "object", + "description": "The parameters for the generic object." + }, + "ConfigurationGroup": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "The configuration group in form of {key, value}." + }, + "ConfigurationGroups": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConfigurationGroup" + }, + "description": "The configuration object for the specified cluster." + }, + "ManagedResourceGroupConfiguration": { + "description": "Managed resource group configuration.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Managed resource group name." + }, + "location": { + "type": "string", + "description": "Managed resource group location." + } + } + }, + "PublisherScope": { + "type": "string", + "description": "Publisher Scope.", + "enum": [ + "Unknown", + "Private" + ], + "x-ms-enum": { + "name": "PublisherScope", + "modelAsString": true + } + }, + "ArtifactAccessCredential": { + "description": "The artifact manifest credential definition.", + "type": "object", + "discriminator": "credentialType", + "required": [ + "credentialType" + ], + "properties": { + "credentialType": { + "type": "string", + "description": "The credential type.", + "enum": [ + "Unknown", + "AzureContainerRegistryScopedToken", + "AzureStorageAccountToken" + ], + "x-ms-enum": { + "name": "CredentialType", + "modelAsString": true + } + } + } + }, + "AzureContainerRegistryScopedTokenCredential": { + "description": "The azure container registry scoped token credential definition.", + "type": "object", + "x-ms-discriminator-value": "AzureContainerRegistryScopedToken", + "allOf": [ + { + "$ref": "#/definitions/ArtifactAccessCredential" + } + ], + "properties": { + "username": { + "type": "string", + "description": "The username of the credential." + }, + "acrToken": { + "type": "string", + "description": "The credential value." + }, + "acrServerUrl": { + "type": "string", + "description": "The Acr server url" + }, + "repositories": { + "type": "array", + "description": "The repositories that could be accessed using the current credential.", + "items": { + "type": "string", + "description": "The repository that could be accessed using the current credential." + }, + "x-ms-identifiers": [] + }, + "expiry": { + "type": "string", + "format": "date-time", + "description": "The UTC time when credential will expire." + } + } + }, + "AzureStorageAccountCredential": { + "description": "The azure storage account credential definition.", + "type": "object", + "x-ms-discriminator-value": "AzureStorageAccountToken", + "allOf": [ + { + "$ref": "#/definitions/ArtifactAccessCredential" + } + ], + "properties": { + "storageAccountId": { + "type": "string", + "description": "The storage account Id" + }, + "containerCredentials": { + "type": "array", + "description": "The containers that could be accessed using the current credential.", + "items": { + "$ref": "#/definitions/AzureStorageAccountContainerCredential", + "description": "The container that could be accessed using the current credential." + }, + "x-ms-identifiers": [] + }, + "expiry": { + "type": "string", + "format": "date-time", + "description": "The UTC time when credential will expire." + } + } + }, + "AzureStorageAccountContainerCredential": { + "description": "The azure storage account container credential definition.", + "type": "object", + "properties": { + "containerName": { + "type": "string", + "description": "The storage account container name" + }, + "containerSasUri": { + "type": "string", + "description": "The storage account container sas uri" + } + } + }, + "DeploymentResourceIdReference": { + "description": "The azure resource reference which is used for deployment.", + "type": "object", + "discriminator": "idType", + "required": [ + "idType" + ], + "properties": { + "idType": { + "description": "The resource reference arm id type.", + "$ref": "#/definitions/IdType" + } + } + }, + "SecretDeploymentResourceReference": { + "description": "Secret deployment resource id reference.", + "x-ms-discriminator-value": "Secret", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DeploymentResourceIdReference" + } + ], + "properties": { + "id": { + "type": "string", + "x-ms-secret": true, + "description": "Resource ID.", + "x-ms-mutability": [ + "create", + "update" + ] + } + } + }, + "OpenDeploymentResourceReference": { + "description": "Non secret deployment resource id reference.", + "x-ms-discriminator-value": "Open", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DeploymentResourceIdReference" + } + ], + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "x-ms-azure-resource": true + }, + "IdType": { + "type": "string", + "description": "The resource reference arm id type.", + "default": "Open", + "enum": [ + "Unknown", + "Open", + "Secret" + ], + "x-ms-enum": { + "name": "idType", + "modelAsString": true + } + } + }, + "parameters": { + "PublisherNameParameter": { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the publisher.", + "x-ms-parameter-location": "method" + }, + "SiteNameParameter": { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the network service site.", + "x-ms-parameter-location": "method" + }, + "NetworkServiceDesignGroupNameParameter": { + "name": "networkServiceDesignGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the network service design group.", + "x-ms-parameter-location": "method" + }, + "ConfigurationGroupValueNameParameter": { + "name": "configurationGroupValueName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the configuration group value.", + "x-ms-parameter-location": "method" + }, + "ConfigurationGroupSchemaNameParameter": { + "name": "configurationGroupSchemaName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the configuration group schema.", + "x-ms-parameter-location": "method" + }, + "NetworkServiceDesignVersionNameParameter": { + "name": "networkServiceDesignVersionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$", + "maxLength": 64, + "description": "The name of the network service design version. The name should conform to the SemVer 2.0.0 specification: https://semver.org/spec/v2.0.0.html.", + "x-ms-parameter-location": "method" + }, + "SiteNetworkServiceNameParameter": { + "name": "siteNetworkServiceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the site network service.", + "x-ms-parameter-location": "method" + }, + "NetworkFunctionDefinitionGroupNameParameter": { + "name": "networkFunctionDefinitionGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the network function definition group.", + "x-ms-parameter-location": "method" + }, + "NetworkFunctionDefinitionVersionNameParameter": { + "name": "networkFunctionDefinitionVersionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$", + "maxLength": 64, + "description": "The name of the network function definition version. The name should conform to the SemVer 2.0.0 specification: https://semver.org/spec/v2.0.0.html.", + "x-ms-parameter-location": "method" + }, + "ArtifactStoreParameter": { + "name": "artifactStoreName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the artifact store.", + "x-ms-parameter-location": "method" + }, + "ArtifactManifestParameter": { + "name": "artifactManifestName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[^\\s]*[^\\s]+[^\\s]*$", + "maxLength": 64, + "description": "The name of the artifact manifest.", + "x-ms-parameter-location": "method" + }, + "PublisherScopeNameParameter": { + "name": "publisherScopeName", + "in": "query", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the publisher scope.", + "x-ms-parameter-location": "method" + }, + "PublisherLocationNameParameter": { + "name": "publisherLocationName", + "in": "query", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the publisher location.", + "x-ms-parameter-location": "method" + }, + "ProxyPublisherNameParameter": { + "name": "proxyPublisherName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the proxy publisher.", + "x-ms-parameter-location": "method" + }, + "ArtifactNameParameter": { + "name": "artifactName", + "in": "query", + "required": true, + "type": "string", + "pattern": "^[^\\s]*[^\\s]+[^\\s]*$", + "maxLength": 64, + "description": "The name of the artifact.", + "x-ms-parameter-location": "method" + }, + "ArtifactVersionNameParameter": { + "name": "artifactVersionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[^\\s]*[^\\s]+[^\\s]*$", + "maxLength": 64, + "description": "The name of the artifact version.", + "x-ms-parameter-location": "method" + }, + "NetworkFunctionNameParameter": { + "name": "networkFunctionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[^\\s]*[^\\s]+[^\\s]*$", + "maxLength": 64, + "description": "The name of the network function.", + "x-ms-parameter-location": "method" + }, + "NetworkFunctionComponentNameParameter": { + "name": "componentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[^\\s]*[^\\s]+[^\\s]*$", + "maxLength": 64, + "description": "The name of the component.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/configurationGroupSchema.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/configurationGroupSchema.json new file mode 100644 index 000000000000..cfbb04ba0db9 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/configurationGroupSchema.json @@ -0,0 +1,453 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used by publishers to on-board offerings and manage network functions.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/configurationGroupSchemas": { + "get": { + "tags": [ + "ConfigurationGroupSchemas" + ], + "operationId": "ConfigurationGroupSchemas_ListByPublisher", + "description": "Gets information of the configuration group schemas under a publisher.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting configuration group schema resource.", + "schema": { + "$ref": "#/definitions/ConfigurationGroupSchemaListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get networkFunctionDefinition groups under publisher resource": { + "$ref": "./examples/ConfigurationGroupSchemaListByPublisherName.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/configurationGroupSchemas/{configurationGroupSchemaName}": { + "delete": { + "tags": [ + "ConfigurationGroupSchemas" + ], + "operationId": "ConfigurationGroupSchemas_Delete", + "description": "Deletes a specified configuration group schema.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ConfigurationGroupSchemaNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. Sets provisioningState to 'Deleting' until the operation is completed. Returns an operation URI that can be queried to find the current state of the operation.", + "headers": { + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "204": { + "description": "Request is successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a network function group resource": { + "$ref": "./examples/ConfigurationGroupSchemaDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "put": { + "tags": [ + "ConfigurationGroupSchemas" + ], + "operationId": "ConfigurationGroupSchemas_CreateOrUpdate", + "description": "Creates or updates a configuration group schema.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ConfigurationGroupSchemaNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationGroupSchema" + }, + "description": "Parameters supplied to the create or update configuration group schema resource." + } + ], + "responses": { + "200": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting configuration group schema resource.", + "schema": { + "$ref": "#/definitions/ConfigurationGroupSchema" + } + }, + "201": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting configuration group schema sub resource.", + "schema": { + "$ref": "#/definitions/ConfigurationGroupSchema" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update the network function definition group": { + "$ref": "./examples/ConfigurationGroupSchemaCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ConfigurationGroupSchemas" + ], + "operationId": "ConfigurationGroupSchemas_Get", + "description": "Gets information about the specified configuration group schema.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ConfigurationGroupSchemaNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting publisher network function definition group resource.", + "schema": { + "$ref": "#/definitions/ConfigurationGroupSchema" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a networkFunctionDefinition group resource": { + "$ref": "./examples/ConfigurationGroupSchemaGet.json" + } + } + }, + "patch": { + "tags": [ + "ConfigurationGroupSchemas" + ], + "operationId": "ConfigurationGroupSchemas_Update", + "description": "Updates a configuration group schema resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ConfigurationGroupSchemaNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the create or update network service design version operation." + } + ], + "responses": { + "200": { + "description": "Creation or update is successful. The operation returns the resulting configuration group schema resource.", + "schema": { + "$ref": "#/definitions/ConfigurationGroupSchema" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update the configuration group schema resource": { + "$ref": "./examples/ConfigurationGroupSchemaUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/configurationGroupSchemas/{configurationGroupSchemaName}/updateState": { + "post": { + "tags": [ + "ConfigurationGroupSchemas" + ], + "operationId": "ConfigurationGroupSchemas_updateState", + "description": "Update configuration group schema state.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ConfigurationGroupSchemaNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationGroupSchemaVersionUpdateState" + }, + "description": "Parameters supplied to update the state of configuration group schema." + } + ], + "responses": { + "200": { + "description": "The updated configuration group schema state.", + "schema": { + "$ref": "#/definitions/ConfigurationGroupSchemaVersionUpdateState" + } + }, + "202": { + "description": "The request of updating configuration group schema state is accepted.", + "headers": { + "Location": { + "description": "The Location 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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update network service design version state": { + "$ref": "./examples/ConfigurationGroupSchemaVersionUpdateState.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "ConfigurationGroupSchema": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/ConfigurationGroupSchemaPropertiesFormat", + "description": "Configuration group schema properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Configuration group schema resource." + }, + "ConfigurationGroupSchemaPropertiesFormat": { + "description": "Configuration group schema properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Configuration group schema resource." + }, + "versionState": { + "readOnly": true, + "description": "The configuration group schema version state.", + "$ref": "#/definitions/ConfigurationGroupSchemaVersionState" + }, + "description": { + "type": "string", + "description": "Description of what schema can contain." + }, + "schemaDefinition": { + "type": "string", + "description": "Name and value pairs that define the configuration value. It can be a well formed escaped JSON string." + } + } + }, + "ConfigurationGroupSchemaListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationGroupSchema" + }, + "description": "A list of configuration group schema." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of configuration group schema resources." + }, + "ConfigurationGroupSchemaVersionState": { + "type": "string", + "description": "The configuration group schema state.", + "enum": [ + "Unknown", + "Preview", + "Active", + "Deprecated" + ], + "x-ms-enum": { + "name": "versionState", + "modelAsString": true + } + }, + "ConfigurationGroupSchemaVersionUpdateState": { + "type": "object", + "description": "Publisher configuration group schema update request definition.", + "properties": { + "versionState": { + "description": "The configuration group schema state.", + "$ref": "#/definitions/ConfigurationGroupSchemaVersionState", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/configurationGroupValues.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/configurationGroupValues.json new file mode 100644 index 000000000000..217c5b14b0cb --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/configurationGroupValues.json @@ -0,0 +1,454 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage the hybrid network configuration group values.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/configurationGroupValues/{configurationGroupValueName}": { + "delete": { + "tags": [ + "ConfigurationGroupValues" + ], + "operationId": "ConfigurationGroupValues_Delete", + "description": "Deletes the specified hybrid configuration group value.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/ConfigurationGroupValueNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation.", + "headers": { + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete hybrid configuration group resource": { + "$ref": "./examples/ConfigurationGroupValueDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ConfigurationGroupValues" + ], + "operationId": "ConfigurationGroupValues_Get", + "description": "Gets information about the specified hybrid configuration group values.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/ConfigurationGroupValueNameParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting hybrid configuration group resource.", + "schema": { + "$ref": "#/definitions/configurationGroupValue" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get hybrid configuration group": { + "$ref": "./examples/ConfigurationGroupValueGet.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationGroupValues" + ], + "operationId": "ConfigurationGroupValues_CreateOrUpdate", + "description": "Creates or updates a hybrid configuration group value.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/ConfigurationGroupValueNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/configurationGroupValue" + }, + "description": "Parameters supplied to the create or update configuration group value resource." + } + ], + "responses": { + "200": { + "description": "Create or update operation has been completed successfully.", + "schema": { + "$ref": "#/definitions/configurationGroupValue" + } + }, + "201": { + "description": "Create or update operation has been completed successfully. The header contains 'Azure-AsyncOperation' header pointing to an operations resource. The operation URI can be queried to find the current state of the operation.", + "schema": { + "$ref": "#/definitions/configurationGroupValue" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update configuration group value": { + "$ref": "./examples/ConfigurationGroupValueCreate.json" + }, + "Create or update configuration group value with secrets": { + "$ref": "./examples/ConfigurationGroupValueCreateSecret.json" + }, + "Create or update first party configuration group value": { + "$ref": "./examples/ConfigurationGroupValueFirstPartyCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "ConfigurationGroupValues" + ], + "operationId": "ConfigurationGroupValues_UpdateTags", + "description": "Updates a hybrid configuration group tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/ConfigurationGroupValueNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update configuration group values tags." + } + ], + "responses": { + "200": { + "description": "Update is successful. The operation returns the resulting hybrid configuration group resource.", + "schema": { + "$ref": "#/definitions/configurationGroupValue" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update hybrid configuration group tags": { + "$ref": "./examples/ConfigurationGroupValueUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/configurationGroupValues": { + "get": { + "tags": [ + "ConfigurationGroupValues" + ], + "operationId": "ConfigurationGroupValues_ListBySubscription", + "description": "Lists all sites in the configuration group value in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of hybrid network site resources.", + "schema": { + "$ref": "#/definitions/configurationGroupValueListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all hybrid network sites in a subscription.": { + "$ref": "./examples/ConfigurationGroupValueListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/configurationGroupValues": { + "get": { + "tags": [ + "ConfigurationGroupValues" + ], + "operationId": "ConfigurationGroupValues_ListByResourceGroup", + "description": "Lists all the hybrid network configurationGroupValues in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of hybrid configuration group value resources.", + "schema": { + "$ref": "#/definitions/configurationGroupValueListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all hybrid network configurationGroupValues in a subscription.": { + "$ref": "./examples/ConfigurationGroupValueListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "configurationGroupValue": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/configurationGroupValuePropertiesFormat", + "description": "Hybrid configuration group value properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Hybrid configuration group value resource." + }, + "configurationGroupValuePropertiesFormat": { + "type": "object", + "description": "Hybrid configuration group value properties.", + "required": [ + "configurationType" + ], + "discriminator": "configurationType", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the site resource." + }, + "publisherName": { + "readOnly": true, + "type": "string", + "description": "The publisher name for the configuration group schema." + }, + "publisherScope": { + "readOnly": true, + "$ref": "./common.json#/definitions/PublisherScope", + "description": "The scope of the publisher." + }, + "configurationGroupSchemaName": { + "readOnly": true, + "type": "string", + "description": "The configuration group schema name." + }, + "configurationGroupSchemaOfferingLocation": { + "readOnly": true, + "type": "string", + "description": "The location of the configuration group schema offering." + }, + "configurationGroupSchemaResourceReference": { + "$ref": "./common.json#/definitions/DeploymentResourceIdReference", + "description": "The configuration group schema resource reference." + }, + "configurationType": { + "$ref": "#/definitions/configurationGroupValueConfigurationType", + "description": "The value which indicates if configuration values are secrets" + } + } + }, + "ConfigurationValueWithSecrets": { + "description": "The ConfigurationValue with secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/configurationGroupValuePropertiesFormat" + } + ], + "properties": { + "secretConfigurationValue": { + "type": "string", + "description": "Name and value pairs that define the configuration value secrets. It can be a well formed escaped JSON string.", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + } + }, + "x-ms-discriminator-value": "Secret" + }, + "ConfigurationValueWithoutSecrets": { + "description": "The ConfigurationValue with no secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/configurationGroupValuePropertiesFormat" + } + ], + "properties": { + "configurationValue": { + "type": "string", + "description": "Name and value pairs that define the configuration value. It can be a well formed escaped JSON string." + } + }, + "x-ms-discriminator-value": "Open" + }, + "configurationGroupValueListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/configurationGroupValue" + }, + "description": "A list of hybrid configurationGroups." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for hybrid configurationGroups API service call." + }, + "configurationGroupValueConfigurationType": { + "type": "string", + "description": "The secret type which indicates if secret or not.", + "enum": [ + "Unknown", + "Secret", + "Open" + ], + "x-ms-enum": { + "name": "ConfigurationGroupValueConfigurationType", + "modelAsString": true + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestCreate.json new file mode 100644 index 000000000000..601b968b1f25 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestCreate.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "artifactStoreName": "TestArtifactStore", + "artifactManifestName": "TestManifest", + "parameters": { + "location": "eastus", + "properties": { + "artifacts": [ + { + "artifactName": "fed-rbac", + "artifactType": "OCIArtifact", + "artifactVersion": "1.0.0" + }, + { + "artifactName": "nginx", + "artifactType": "OCIArtifact", + "artifactVersion": "v1" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/microsoft.hybridnetwork/publishers/UnityCloud/artifactStores/TestArtifactStore/artifactManifests/TestManifest", + "name": "TestManifest", + "type": "microsoft.hybridnetwork/publishers/artifactStores/artifactManifests", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "artifactManifestState": "Uploaded", + "artifacts": [ + { + "artifactName": "fed-rbac", + "artifactType": "OCIArtifact", + "artifactVersion": "1.0.0" + }, + { + "artifactName": "nginx", + "artifactType": "OCIArtifact", + "artifactVersion": "v1" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/microsoft.hybridnetwork/publishers/UnityCloud/artifactStores/TestArtifactStore/artifactManifests/TestManifest", + "name": "TestManifest", + "type": "microsoft.hybridnetwork/publishers/artifactStores/artifactManifests", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "artifactManifestState": "Uploading", + "artifacts": [ + { + "artifactName": "fed-rbac", + "artifactType": "OCIArtifact", + "artifactVersion": "1.0.0" + }, + { + "artifactName": "nginx", + "artifactType": "OCIArtifact", + "artifactVersion": "v1" + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestDelete.json new file mode 100644 index 000000000000..7a3e095642ed --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "artifactStoreName": "TestArtifactStore", + "artifactManifestName": "TestManifest" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestGet.json new file mode 100644 index 000000000000..70b078d29da2 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "artifactStoreName": "TestArtifactStore", + "artifactManifestName": "TestManifest" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/microsoft.hybridnetwork/publishers/UnityCloud/artifactStores/TestArtifactStore/artifactManifests/TestManifest", + "name": "TestManifest", + "type": "microsoft.hybridnetwork/publishers/artifactStores/artifactManifests", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "artifactManifestState": "Uploaded", + "artifacts": [ + { + "artifactName": "fed-rbac", + "artifactType": "OCIArtifact", + "artifactVersion": "1.0.0" + }, + { + "artifactName": "nginx", + "artifactType": "OCIArtifact", + "artifactVersion": "v1" + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestListByArtifactStore.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestListByArtifactStore.json new file mode 100644 index 000000000000..c75618028e1d --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestListByArtifactStore.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "artifactStoreName": "TestArtifactStore" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore/artifactManifests/TestManifest", + "name": "TestManifest", + "type": "microsoft.hybridnetwork/publishers/artifactStores/artifactManifests", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "artifactManifestState": "Uploaded", + "artifacts": [ + { + "artifactName": "fed-rbac", + "artifactType": "OCIArtifact", + "artifactVersion": "1.0.0" + }, + { + "artifactName": "nginx", + "artifactType": "OCIArtifact", + "artifactVersion": "v1" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestListCredential.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestListCredential.json new file mode 100644 index 000000000000..8789fa2579ff --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestListCredential.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "artifactStoreName": "TestArtifactStore", + "artifactManifestName": "TestArtifactManifestName" + }, + "responses": { + "200": { + "body": { + "credentialType": "AzureContainerRegistryScopedToken", + "username": "dummyuser", + "acrToken": "dummytoken", + "expiry": "2022-06-07T18:01:41.334+00:00", + "acrServerUrl": "test.azurecr.io", + "repositories": [ + "" + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestUpdateState.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestUpdateState.json new file mode 100644 index 000000000000..9ee332ac7f0f --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestUpdateState.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "artifactStoreName": "TestArtifactStore", + "artifactManifestName": "TestArtifactManifestName", + "parameters": { + "artifactManifestState": "Uploaded" + } + }, + "responses": { + "200": { + "body": { + "artifactManifestState": "Uploaded" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestUpdateTags.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestUpdateTags.json new file mode 100644 index 000000000000..56a17fb65d67 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestUpdateTags.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "artifactStoreName": "TestArtifactStore", + "artifactManifestName": "TestManifest", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/microsoft.hybridnetwork/publishers/UnityCloud/artifactStores/TestArtifactStore/artifactManifests/TestManifest", + "name": "TestManifest", + "type": "microsoft.hybridnetwork/publishers/artifactStores/artifactManifests", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "artifactManifestState": "Uploaded", + "artifacts": [ + { + "artifactName": "fed-rbac", + "artifactType": "OCIArtifact", + "artifactVersion": "1.0.0" + }, + { + "artifactName": "nginx", + "artifactType": "OCIArtifact", + "artifactVersion": "v1" + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreCreate.json new file mode 100644 index 000000000000..44420842b269 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreCreate.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "artifactStoreName": "TestArtifactStore", + "parameters": { + "location": "eastus", + "properties": { + "storeType": "AzureContainerRegistry", + "replicationStrategy": "SingleReplication", + "managedResourceGroupConfiguration": { + "name": "testRg", + "location": "eastus" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestArtifactStore", + "id": "/subscriptions/subid/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore", + "type": "microsoft.hybridnetwork/publishers/artifactStores", + "location": "eastus", + "properties": { + "storeType": "AzureContainerRegistry", + "replicationStrategy": "SingleReplication", + "storageResourceId": "TestResourceId", + "managedResourceGroupConfiguration": { + "name": "testRg", + "location": "eastus" + } + } + } + }, + "201": { + "body": { + "name": "TestArtifactStore", + "id": "/subscriptions/subid/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore", + "type": "microsoft.hybridnetwork/publishers/artifactStores", + "location": "eastus", + "properties": { + "storeType": "AzureContainerRegistry", + "replicationStrategy": "SingleReplication", + "storageResourceId": "TestResourceId", + "managedResourceGroupConfiguration": { + "name": "testRg", + "location": "eastus" + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreDelete.json new file mode 100644 index 000000000000..74b3baa0bc79 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "artifactStoreName": "TestArtifactStore" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreGet.json new file mode 100644 index 000000000000..13786eb64ae4 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "artifactStoreName": "TestArtifactStoreName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore", + "name": "TestArtifactStore", + "type": "microsoft.hybridnetwork/publishers/artifactStores", + "location": "eastus", + "properties": { + "storeType": "AzureContainerRegistry", + "replicationStrategy": "SingleReplication", + "storageResourceId": "TestResourceId", + "managedResourceGroupConfiguration": { + "name": "testRg", + "location": "eastus" + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreUpdateTags.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreUpdateTags.json new file mode 100644 index 000000000000..7bec3fcb8f08 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreUpdateTags.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "artifactStoreName": "TestArtifactStore", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestArtifactStore", + "id": "/subscriptions/subid/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore", + "type": "microsoft.hybridnetwork/publishers/artifactStores", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "storeType": "AzureContainerRegistry", + "replicationStrategy": "SingleReplication", + "storageResourceId": "TestResourceId", + "managedResourceGroupConfiguration": { + "name": "testRg", + "location": "eastus" + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoresListByPublisherName.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoresListByPublisherName.json new file mode 100644 index 000000000000..64537cf091d2 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoresListByPublisherName.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore", + "name": "TestArtifactStore", + "type": "microsoft.hybridnetwork/publishers/artifactStores", + "location": "eastus", + "properties": { + "storeType": "AzureContainerRegistry", + "replicationStrategy": "SingleReplication", + "storageResourceId": "TestResourceId", + "managedResourceGroupConfiguration": { + "name": "testRg", + "location": "eastus" + } + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionCreate.json new file mode 100644 index 000000000000..ae931a386f32 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionCreate.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf", + "parameters": { + "location": "eastus", + "properties": { + "nfviType": "AzureCore", + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviId": "/subscriptions/subid/resourceGroups/testResourceGroup", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"virtualMachineName\":\"test-VM\",\"cpuCores\":4,\"memorySizeGB\":8,\"cloudServicesNetworkAttachment\":{\"attachedNetworkId\":\"test-csnet\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-cs-vlan\"},\"networkAttachments\":[{\"attachedNetworkId\":\"test-l3vlan\",\"defaultGateway\":\"True\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-vlan\"}],\"sshPublicKeys\":[{\"keyData\":\"ssh-rsa CMIIIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0TqlveKKlc2MFvEmuXJiLGBsY1t4ML4uiRADGSZlnc+7Ugv3h+MCjkkwOKiOdsNo8k4KSBIG5GcQfKYOOd17AJvqCL6cGQbaLuqv0a64jeDm8oO8/xN/IM0oKw7rMr/2oAJOgIsfeXPkRxWWic9AVIS++H5Qi2r7bUFX+cqFsyUCAwEBBQ==\"}],\"storageProfile\":{\"osDisk\":{\"createOption\":\"Ephemeral\",\"deleteOption\":\"Delete\",\"diskSizeGB\":10}},\"userData\":\"testUserData\",\"adminUsername\":\"testUser\",\"virtioInterface\":\"Transitional\",\"isolateEmulatorThread\":\"False\",\"bootMethod\":\"BIOS\",\"placementHints\":[]}" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publisherName": "TestPublisher", + "publisherScope": "Private", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.0", + "networkFunctionDefinitionOfferingLocation": "eastus", + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviType": "AzureCore", + "nfviId": "/subscriptions/subid/resourceGroups/testResourceGroup", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"virtualMachineName\":\"test-VM\",\"cpuCores\":4,\"memorySizeGB\":8,\"cloudServicesNetworkAttachment\":{\"attachedNetworkId\":\"test-csnet\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-cs-vlan\"},\"networkAttachments\":[{\"attachedNetworkId\":\"test-l3vlan\",\"defaultGateway\":\"True\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-vlan\"}],\"sshPublicKeys\":[{\"keyData\":\"ssh-rsa CMIIIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0TqlveKKlc2MFvEmuXJiLGBsY1t4ML4uiRADGSZlnc+7Ugv3h+MCjkkwOKiOdsNo8k4KSBIG5GcQfKYOOd17AJvqCL6cGQbaLuqv0a64jeDm8oO8/xN/IM0oKw7rMr/2oAJOgIsfeXPkRxWWic9AVIS++H5Qi2r7bUFX+cqFsyUCAwEBBQ==\"}],\"storageProfile\":{\"osDisk\":{\"createOption\":\"Ephemeral\",\"deleteOption\":\"Delete\",\"diskSizeGB\":10}},\"userData\":\"testUserData\",\"adminUsername\":\"testUser\",\"virtioInterface\":\"Transitional\",\"isolateEmulatorThread\":\"False\",\"bootMethod\":\"BIOS\",\"placementHints\":[]}" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Accepted", + "publisherName": "TestPublisher", + "publisherScope": "Private", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.0", + "networkFunctionDefinitionOfferingLocation": "eastus", + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviType": "AzureCore", + "nfviId": "/subscriptions/subid/resourceGroups/testResourceGroup", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"virtualMachineName\":\"test-VM\",\"cpuCores\":4,\"memorySizeGB\":8,\"cloudServicesNetworkAttachment\":{\"attachedNetworkId\":\"test-csnet\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-cs-vlan\"},\"networkAttachments\":[{\"attachedNetworkId\":\"test-l3vlan\",\"defaultGateway\":\"True\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-vlan\"}],\"sshPublicKeys\":[{\"keyData\":\"ssh-rsa CMIIIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0TqlveKKlc2MFvEmuXJiLGBsY1t4ML4uiRADGSZlnc+7Ugv3h+MCjkkwOKiOdsNo8k4KSBIG5GcQfKYOOd17AJvqCL6cGQbaLuqv0a64jeDm8oO8/xN/IM0oKw7rMr/2oAJOgIsfeXPkRxWWic9AVIS++H5Qi2r7bUFX+cqFsyUCAwEBBQ==\"}],\"storageProfile\":{\"osDisk\":{\"createOption\":\"Ephemeral\",\"deleteOption\":\"Delete\",\"diskSizeGB\":10}},\"userData\":\"testUserData\",\"adminUsername\":\"testUser\",\"virtioInterface\":\"Transitional\",\"isolateEmulatorThread\":\"False\",\"bootMethod\":\"BIOS\",\"placementHints\":[]}" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDefinitionVersionCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDefinitionVersionCreate.json new file mode 100644 index 000000000000..d7ab6e552d20 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDefinitionVersionCreate.json @@ -0,0 +1,226 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersionName": "1.0.0", + "parameters": { + "location": "eastus", + "properties": { + "versionState": "Preview", + "description": "test NFDV for AzureCore", + "deployParameters": "{\"virtualMachineName\":{\"type\":\"string\"},\"cpuCores\":{\"type\":\"int\"},\"memorySizeGB\":{\"type\":\"int\"},\"cloudServicesNetworkAttachment\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]},\"networkAttachments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]}},\"storageProfile\":{\"type\":\"object\",\"properties\":{\"osDisk\":{\"type\":\"object\",\"properties\":{\"createOption\":{\"type\":\"string\"},\"deleteOption\":{\"type\":\"string\"},\"diskSizeGB\":{\"type\":\"integer\"}},\"required\":[\"diskSizeGB\"]}},\"required\":[\"osDisk\"]},\"sshPublicKeys\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"keyData\":{\"type\":\"string\"}},\"required\":[\"keyData\"]}},\"userData\":{\"type\":\"string\"},\"adminUsername\":{\"type\":\"string\"},\"bootMethod\":{\"type\":\"string\",\"default\":\"UEFI\",\"enum\":[\"UEFI\",\"BIOS\"]},\"isolateEmulatorThread\":{\"type\":\"string\"},\"virtioInterface\":{\"type\":\"string\"},\"placementHints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"hintType\":{\"type\":\"string\",\"enum\":[\"Affinity\",\"AntiAffinity\"]},\"resourceId\":{\"type\":\"string\"},\"schedulingExecution\":{\"type\":\"string\",\"enum\":[\"Soft\",\"Hard\"]},\"scope\":{\"type\":\"string\"}},\"required\":[\"hintType\",\"schedulingExecution\",\"resourceId\",\"scope\"]}}}", + "networkFunctionType": "VirtualNetworkFunction", + "networkFunctionTemplate": { + "nfviType": "AzureCore", + "networkFunctionApplications": [ + { + "name": "testImageRole", + "artifactType": "VhdImageFile", + "dependsOnProfile": { + "installDependsOn": [], + "uninstallDependsOn": [], + "updateDependsOn": [] + }, + "artifactProfile": { + "vhdArtifactProfile": { + "vhdName": "test-image", + "vhdVersion": "1-0-0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "vhdImageMappingRuleProfile": { + "userConfiguration": "" + }, + "applicationEnablement": "Unknown" + } + }, + { + "name": "testTemplateRole", + "artifactType": "ArmTemplate", + "dependsOnProfile": { + "installDependsOn": [ + "testImageRole" + ], + "uninstallDependsOn": [ + "testImageRole" + ], + "updateDependsOn": [ + "testImageRole" + ] + }, + "artifactProfile": { + "templateArtifactProfile": { + "templateName": "test-template", + "templateVersion": "1.0.0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "templateMappingRuleProfile": { + "templateParameters": "{\"virtualMachineName\":\"{deployParameters.virtualMachineName}\",\"cpuCores\":\"{deployParameters.cpuCores}\",\"memorySizeGB\":\"{deployParameters.memorySizeGB}\",\"cloudServicesNetworkAttachment\":\"{deployParameters.cloudServicesNetworkAttachment}\",\"networkAttachments\":\"{deployParameters.networkAttachments}\",\"sshPublicKeys\":\"{deployParameters.sshPublicKeys}\",\"storageProfile\":\"{deployParameters.storageProfile}\",\"isolateEmulatorThread\":\"{deployParameters.isolateEmulatorThread}\",\"virtioInterface\":\"{deployParameters.virtioInterface}\",\"userData\":\"{deployParameters.userData}\",\"adminUsername\":\"{deployParameters.adminUsername}\",\"bootMethod\":\"{deployParameters.bootMethod}\",\"placementHints\":\"{deployParameters.placementHints}\"}" + }, + "applicationEnablement": "Unknown" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions", + "location": "eastus", + "properties": { + "versionState": "Preview", + "description": "test NFDV for AzureCore", + "deployParameters": "{\"virtualMachineName\":{\"type\":\"string\"},\"cpuCores\":{\"type\":\"int\"},\"memorySizeGB\":{\"type\":\"int\"},\"cloudServicesNetworkAttachment\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]},\"networkAttachments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]}},\"storageProfile\":{\"type\":\"object\",\"properties\":{\"osDisk\":{\"type\":\"object\",\"properties\":{\"createOption\":{\"type\":\"string\"},\"deleteOption\":{\"type\":\"string\"},\"diskSizeGB\":{\"type\":\"integer\"}},\"required\":[\"diskSizeGB\"]}},\"required\":[\"osDisk\"]},\"sshPublicKeys\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"keyData\":{\"type\":\"string\"}},\"required\":[\"keyData\"]}},\"userData\":{\"type\":\"string\"},\"adminUsername\":{\"type\":\"string\"},\"bootMethod\":{\"type\":\"string\",\"default\":\"UEFI\",\"enum\":[\"UEFI\",\"BIOS\"]},\"isolateEmulatorThread\":{\"type\":\"string\"},\"virtioInterface\":{\"type\":\"string\"},\"placementHints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"hintType\":{\"type\":\"string\",\"enum\":[\"Affinity\",\"AntiAffinity\"]},\"resourceId\":{\"type\":\"string\"},\"schedulingExecution\":{\"type\":\"string\",\"enum\":[\"Soft\",\"Hard\"]},\"scope\":{\"type\":\"string\"}},\"required\":[\"hintType\",\"schedulingExecution\",\"resourceId\",\"scope\"]}}}", + "networkFunctionType": "VirtualNetworkFunction", + "networkFunctionTemplate": { + "nfviType": "AzureCore", + "networkFunctionApplications": [ + { + "name": "testImageRole", + "artifactType": "VhdImageFile", + "dependsOnProfile": { + "installDependsOn": [], + "uninstallDependsOn": [], + "updateDependsOn": [] + }, + "artifactProfile": { + "vhdArtifactProfile": { + "vhdName": "test-image", + "vhdVersion": "1-0-0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "vhdImageMappingRuleProfile": { + "userConfiguration": "" + }, + "applicationEnablement": "Unknown" + } + }, + { + "name": "testTemplateRole", + "artifactType": "ArmTemplate", + "dependsOnProfile": { + "installDependsOn": [ + "testImageRole" + ], + "uninstallDependsOn": [ + "testImageRole" + ], + "updateDependsOn": [ + "testImageRole" + ] + }, + "artifactProfile": { + "templateArtifactProfile": { + "templateName": "test-template", + "templateVersion": "1.0.0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "templateMappingRuleProfile": { + "templateParameters": "{\"virtualMachineName\":\"{deployParameters.virtualMachineName}\",\"cpuCores\":\"{deployParameters.cpuCores}\",\"memorySizeGB\":\"{deployParameters.memorySizeGB}\",\"cloudServicesNetworkAttachment\":\"{deployParameters.cloudServicesNetworkAttachment}\",\"networkAttachments\":\"{deployParameters.networkAttachments}\",\"sshPublicKeys\":\"{deployParameters.sshPublicKeys}\",\"storageProfile\":\"{deployParameters.storageProfile}\",\"isolateEmulatorThread\":\"{deployParameters.isolateEmulatorThread}\",\"virtioInterface\":\"{deployParameters.virtioInterface}\",\"userData\":\"{deployParameters.userData}\",\"adminUsername\":\"{deployParameters.adminUsername}\",\"bootMethod\":\"{deployParameters.bootMethod}\",\"placementHints\":\"{deployParameters.placementHints}\"}" + }, + "applicationEnablement": "Unknown" + } + } + ] + } + } + } + }, + "201": { + "body": { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions", + "location": "eastus", + "properties": { + "versionState": "Preview", + "description": "test NFDV for AzureCore", + "deployParameters": "{\"virtualMachineName\":{\"type\":\"string\"},\"cpuCores\":{\"type\":\"int\"},\"memorySizeGB\":{\"type\":\"int\"},\"cloudServicesNetworkAttachment\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]},\"networkAttachments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]}},\"storageProfile\":{\"type\":\"object\",\"properties\":{\"osDisk\":{\"type\":\"object\",\"properties\":{\"createOption\":{\"type\":\"string\"},\"deleteOption\":{\"type\":\"string\"},\"diskSizeGB\":{\"type\":\"integer\"}},\"required\":[\"diskSizeGB\"]}},\"required\":[\"osDisk\"]},\"sshPublicKeys\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"keyData\":{\"type\":\"string\"}},\"required\":[\"keyData\"]}},\"userData\":{\"type\":\"string\"},\"adminUsername\":{\"type\":\"string\"},\"bootMethod\":{\"type\":\"string\",\"default\":\"UEFI\",\"enum\":[\"UEFI\",\"BIOS\"]},\"isolateEmulatorThread\":{\"type\":\"string\"},\"virtioInterface\":{\"type\":\"string\"},\"placementHints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"hintType\":{\"type\":\"string\",\"enum\":[\"Affinity\",\"AntiAffinity\"]},\"resourceId\":{\"type\":\"string\"},\"schedulingExecution\":{\"type\":\"string\",\"enum\":[\"Soft\",\"Hard\"]},\"scope\":{\"type\":\"string\"}},\"required\":[\"hintType\",\"schedulingExecution\",\"resourceId\",\"scope\"]}}}", + "networkFunctionType": "VirtualNetworkFunction", + "networkFunctionTemplate": { + "nfviType": "AzureCore", + "networkFunctionApplications": [ + { + "name": "testImageRole", + "artifactType": "VhdImageFile", + "dependsOnProfile": { + "installDependsOn": [], + "uninstallDependsOn": [], + "updateDependsOn": [] + }, + "artifactProfile": { + "vhdArtifactProfile": { + "vhdName": "test-image", + "vhdVersion": "1-0-0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "vhdImageMappingRuleProfile": { + "userConfiguration": "" + }, + "applicationEnablement": "Unknown" + } + }, + { + "name": "testTemplateRole", + "artifactType": "ArmTemplate", + "dependsOnProfile": { + "installDependsOn": [ + "testImageRole" + ], + "uninstallDependsOn": [ + "testImageRole" + ], + "updateDependsOn": [ + "testImageRole" + ] + }, + "artifactProfile": { + "templateArtifactProfile": { + "templateName": "test-template", + "templateVersion": "1.0.0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "templateMappingRuleProfile": { + "templateParameters": "{\"virtualMachineName\":\"{deployParameters.virtualMachineName}\",\"cpuCores\":\"{deployParameters.cpuCores}\",\"memorySizeGB\":\"{deployParameters.memorySizeGB}\",\"cloudServicesNetworkAttachment\":\"{deployParameters.cloudServicesNetworkAttachment}\",\"networkAttachments\":\"{deployParameters.networkAttachments}\",\"sshPublicKeys\":\"{deployParameters.sshPublicKeys}\",\"storageProfile\":\"{deployParameters.storageProfile}\",\"isolateEmulatorThread\":\"{deployParameters.isolateEmulatorThread}\",\"virtioInterface\":\"{deployParameters.virtioInterface}\",\"userData\":\"{deployParameters.userData}\",\"adminUsername\":\"{deployParameters.adminUsername}\",\"bootMethod\":\"{deployParameters.bootMethod}\",\"placementHints\":\"{deployParameters.placementHints}\"}" + }, + "applicationEnablement": "Unknown" + } + } + ] + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDefinitionVersionDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDefinitionVersionDelete.json new file mode 100644 index 000000000000..60ec045c9af2 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDefinitionVersionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersionName": "1.0.0" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDefinitionVersionGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDefinitionVersionGet.json new file mode 100644 index 000000000000..f878a2d6c722 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDefinitionVersionGet.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions", + "location": "eastus", + "properties": { + "versionState": "Preview", + "description": "test NFDV for AzureCore", + "deployParameters": "{\"virtualMachineName\":{\"type\":\"string\"},\"cpuCores\":{\"type\":\"int\"},\"memorySizeGB\":{\"type\":\"int\"},\"cloudServicesNetworkAttachment\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]},\"networkAttachments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]}},\"storageProfile\":{\"type\":\"object\",\"properties\":{\"osDisk\":{\"type\":\"object\",\"properties\":{\"createOption\":{\"type\":\"string\"},\"deleteOption\":{\"type\":\"string\"},\"diskSizeGB\":{\"type\":\"integer\"}},\"required\":[\"diskSizeGB\"]}},\"required\":[\"osDisk\"]},\"sshPublicKeys\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"keyData\":{\"type\":\"string\"}},\"required\":[\"keyData\"]}},\"userData\":{\"type\":\"string\"},\"adminUsername\":{\"type\":\"string\"},\"bootMethod\":{\"type\":\"string\",\"default\":\"UEFI\",\"enum\":[\"UEFI\",\"BIOS\"]},\"isolateEmulatorThread\":{\"type\":\"string\"},\"virtioInterface\":{\"type\":\"string\"},\"placementHints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"hintType\":{\"type\":\"string\",\"enum\":[\"Affinity\",\"AntiAffinity\"]},\"resourceId\":{\"type\":\"string\"},\"schedulingExecution\":{\"type\":\"string\",\"enum\":[\"Soft\",\"Hard\"]},\"scope\":{\"type\":\"string\"}},\"required\":[\"hintType\",\"schedulingExecution\",\"resourceId\",\"scope\"]}}}", + "networkFunctionType": "VirtualNetworkFunction", + "networkFunctionTemplate": { + "nfviType": "AzureCore", + "networkFunctionApplications": [ + { + "name": "testImageRole", + "artifactType": "VhdImageFile", + "dependsOnProfile": { + "installDependsOn": [], + "uninstallDependsOn": [], + "updateDependsOn": [] + }, + "artifactProfile": { + "vhdArtifactProfile": { + "vhdName": "test-image", + "vhdVersion": "1-0-0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "vhdImageMappingRuleProfile": { + "userConfiguration": "" + }, + "applicationEnablement": "Unknown" + } + }, + { + "name": "testTemplateRole", + "artifactType": "ArmTemplate", + "dependsOnProfile": { + "installDependsOn": [ + "testImageRole" + ], + "uninstallDependsOn": [ + "testImageRole" + ], + "updateDependsOn": [ + "testImageRole" + ] + }, + "artifactProfile": { + "templateArtifactProfile": { + "templateName": "test-template", + "templateVersion": "1.0.0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "templateMappingRuleProfile": { + "templateParameters": "{\"virtualMachineName\":\"{deployParameters.virtualMachineName}\",\"cpuCores\":\"{deployParameters.cpuCores}\",\"memorySizeGB\":\"{deployParameters.memorySizeGB}\",\"cloudServicesNetworkAttachment\":\"{deployParameters.cloudServicesNetworkAttachment}\",\"networkAttachments\":\"{deployParameters.networkAttachments}\",\"sshPublicKeys\":\"{deployParameters.sshPublicKeys}\",\"storageProfile\":\"{deployParameters.storageProfile}\",\"isolateEmulatorThread\":\"{deployParameters.isolateEmulatorThread}\",\"virtioInterface\":\"{deployParameters.virtioInterface}\",\"userData\":\"{deployParameters.userData}\",\"adminUsername\":\"{deployParameters.adminUsername}\",\"bootMethod\":\"{deployParameters.bootMethod}\",\"placementHints\":\"{deployParameters.placementHints}\"}" + }, + "applicationEnablement": "Unknown" + } + } + ] + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDelete.json new file mode 100644 index 000000000000..a2f57d14a02d --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionGet.json new file mode 100644 index 000000000000..c24aacb84952 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publisherName": "TestPublisher", + "publisherScope": "Private", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.0", + "networkFunctionDefinitionOfferingLocation": "eastus", + "nfviType": "AzureCore", + "nfviId": "/subscriptions/subid/resourceGroups/testResourceGroup", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"virtualMachineName\":\"test-VM\",\"cpuCores\":4,\"memorySizeGB\":8,\"cloudServicesNetworkAttachment\":{\"attachedNetworkId\":\"test-csnet\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-cs-vlan\"},\"networkAttachments\":[{\"attachedNetworkId\":\"test-l3vlan\",\"defaultGateway\":\"True\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-vlan\"}],\"sshPublicKeys\":[{\"keyData\":\"ssh-rsa CMIIIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0TqlveKKlc2MFvEmuXJiLGBsY1t4ML4uiRADGSZlnc+7Ugv3h+MCjkkwOKiOdsNo8k4KSBIG5GcQfKYOOd17AJvqCL6cGQbaLuqv0a64jeDm8oO8/xN/IM0oKw7rMr/2oAJOgIsfeXPkRxWWic9AVIS++H5Qi2r7bUFX+cqFsyUCAwEBBQ==\"}],\"storageProfile\":{\"osDisk\":{\"createOption\":\"Ephemeral\",\"deleteOption\":\"Delete\",\"diskSizeGB\":10}},\"userData\":\"testUserData\",\"adminUsername\":\"testUser\",\"virtioInterface\":\"Transitional\",\"isolateEmulatorThread\":\"False\",\"bootMethod\":\"BIOS\",\"placementHints\":[]}" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionCreate.json new file mode 100644 index 000000000000..e9aa9066c20e --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionCreate.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf", + "parameters": { + "location": "eastus", + "properties": { + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviType": "AzureOperatorNexus", + "nfviId": "/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"virtualMachineName\":\"test-VM\",\"extendedLocationName\":\"test-cluster\",\"cpuCores\":4,\"memorySizeGB\":8,\"cloudServicesNetworkAttachment\":{\"attachedNetworkId\":\"test-csnet\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-cs-vlan\"},\"networkAttachments\":[{\"attachedNetworkId\":\"test-l3vlan\",\"defaultGateway\":\"True\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-vlan\"}],\"sshPublicKeys\":[{\"keyData\":\"ssh-rsa CMIIIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0TqlveKKlc2MFvEmuXJiLGBsY1t4ML4uiRADGSZlnc+7Ugv3h+MCjkkwOKiOdsNo8k4KSBIG5GcQfKYOOd17AJvqCL6cGQbaLuqv0a64jeDm8oO8/xN/IM0oKw7rMr/2oAJOgIsfeXPkRxWWic9AVIS++H5Qi2r7bUFX+cqFsyUCAwEBBQ==\"}],\"storageProfile\":{\"osDisk\":{\"createOption\":\"Ephemeral\",\"deleteOption\":\"Delete\",\"diskSizeGB\":10}},\"userData\":\"testUserData\",\"adminUsername\":\"testUser\",\"virtioInterface\":\"Transitional\",\"isolateEmulatorThread\":\"False\",\"bootMethod\":\"BIOS\",\"placementHints\":[]}" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publisherName": "TestPublisher", + "publisherScope": "Private", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.0", + "networkFunctionDefinitionOfferingLocation": "eastus", + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviType": "AzureOperatorNexus", + "nfviId": "/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"virtualMachineName\":\"test-VM\",\"extendedLocationName\":\"test-cluster\",\"cpuCores\":4,\"memorySizeGB\":8,\"cloudServicesNetworkAttachment\":{\"attachedNetworkId\":\"test-csnet\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-cs-vlan\"},\"networkAttachments\":[{\"attachedNetworkId\":\"test-l3vlan\",\"defaultGateway\":\"True\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-vlan\"}],\"sshPublicKeys\":[{\"keyData\":\"ssh-rsa CMIIIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0TqlveKKlc2MFvEmuXJiLGBsY1t4ML4uiRADGSZlnc+7Ugv3h+MCjkkwOKiOdsNo8k4KSBIG5GcQfKYOOd17AJvqCL6cGQbaLuqv0a64jeDm8oO8/xN/IM0oKw7rMr/2oAJOgIsfeXPkRxWWic9AVIS++H5Qi2r7bUFX+cqFsyUCAwEBBQ==\"}],\"storageProfile\":{\"osDisk\":{\"createOption\":\"Ephemeral\",\"deleteOption\":\"Delete\",\"diskSizeGB\":10}},\"userData\":\"testUserData\",\"adminUsername\":\"testUser\",\"virtioInterface\":\"Transitional\",\"isolateEmulatorThread\":\"False\",\"bootMethod\":\"BIOS\",\"placementHints\":[]}" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Accepted", + "publisherName": "TestPublisher", + "publisherScope": "Private", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.0", + "networkFunctionDefinitionOfferingLocation": "eastus", + "nfviType": "AzureOperatorNexus", + "nfviId": "/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"virtualMachineName\":\"test-VM\",\"extendedLocationName\":\"test-cluster\",\"cpuCores\":4,\"memorySizeGB\":8,\"cloudServicesNetworkAttachment\":{\"attachedNetworkId\":\"test-csnet\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-cs-vlan\"},\"networkAttachments\":[{\"attachedNetworkId\":\"test-l3vlan\",\"defaultGateway\":\"True\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-vlan\"}],\"sshPublicKeys\":[{\"keyData\":\"ssh-rsa CMIIIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0TqlveKKlc2MFvEmuXJiLGBsY1t4ML4uiRADGSZlnc+7Ugv3h+MCjkkwOKiOdsNo8k4KSBIG5GcQfKYOOd17AJvqCL6cGQbaLuqv0a64jeDm8oO8/xN/IM0oKw7rMr/2oAJOgIsfeXPkRxWWic9AVIS++H5Qi2r7bUFX+cqFsyUCAwEBBQ==\"}],\"storageProfile\":{\"osDisk\":{\"createOption\":\"Ephemeral\",\"deleteOption\":\"Delete\",\"diskSizeGB\":10}},\"userData\":\"testUserData\",\"adminUsername\":\"testUser\",\"virtioInterface\":\"Transitional\",\"isolateEmulatorThread\":\"False\",\"bootMethod\":\"BIOS\",\"placementHints\":[]}" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionCreate.json new file mode 100644 index 000000000000..a051c5d42786 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionCreate.json @@ -0,0 +1,226 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersionName": "1.0.0", + "parameters": { + "location": "eastus", + "properties": { + "versionState": "Preview", + "description": "test NFDV for AzureOperatorNexus", + "deployParameters": "{\"virtualMachineName\":{\"type\":\"string\"},\"extendedLocationName\":{\"type\":\"string\"},\"cpuCores\":{\"type\":\"int\"},\"memorySizeGB\":{\"type\":\"int\"},\"cloudServicesNetworkAttachment\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]},\"networkAttachments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]}},\"storageProfile\":{\"type\":\"object\",\"properties\":{\"osDisk\":{\"type\":\"object\",\"properties\":{\"createOption\":{\"type\":\"string\"},\"deleteOption\":{\"type\":\"string\"},\"diskSizeGB\":{\"type\":\"integer\"}},\"required\":[\"diskSizeGB\"]}},\"required\":[\"osDisk\"]},\"sshPublicKeys\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"keyData\":{\"type\":\"string\"}},\"required\":[\"keyData\"]}},\"userData\":{\"type\":\"string\"},\"adminUsername\":{\"type\":\"string\"},\"bootMethod\":{\"type\":\"string\",\"default\":\"UEFI\",\"enum\":[\"UEFI\",\"BIOS\"]},\"isolateEmulatorThread\":{\"type\":\"string\"},\"virtioInterface\":{\"type\":\"string\"},\"placementHints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"hintType\":{\"type\":\"string\",\"enum\":[\"Affinity\",\"AntiAffinity\"]},\"resourceId\":{\"type\":\"string\"},\"schedulingExecution\":{\"type\":\"string\",\"enum\":[\"Soft\",\"Hard\"]},\"scope\":{\"type\":\"string\"}},\"required\":[\"hintType\",\"schedulingExecution\",\"resourceId\",\"scope\"]}}}", + "networkFunctionType": "VirtualNetworkFunction", + "networkFunctionTemplate": { + "nfviType": "AzureOperatorNexus", + "networkFunctionApplications": [ + { + "name": "testImageRole", + "artifactType": "ImageFile", + "dependsOnProfile": { + "installDependsOn": [], + "uninstallDependsOn": [], + "updateDependsOn": [] + }, + "artifactProfile": { + "imageArtifactProfile": { + "imageName": "test-image", + "imageVersion": "1.0.0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "imageMappingRuleProfile": { + "userConfiguration": "" + }, + "applicationEnablement": "Unknown" + } + }, + { + "name": "testTemplateRole", + "artifactType": "ArmTemplate", + "dependsOnProfile": { + "installDependsOn": [ + "testImageRole" + ], + "uninstallDependsOn": [ + "testImageRole" + ], + "updateDependsOn": [ + "testImageRole" + ] + }, + "artifactProfile": { + "templateArtifactProfile": { + "templateName": "test-template", + "templateVersion": "1.0.0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "templateMappingRuleProfile": { + "templateParameters": "{\"virtualMachineName\":\"{deployParameters.virtualMachineName}\",\"extendedLocationName\":\"{deployParameters.extendedLocationName}\",\"cpuCores\":\"{deployParameters.cpuCores}\",\"memorySizeGB\":\"{deployParameters.memorySizeGB}\",\"cloudServicesNetworkAttachment\":\"{deployParameters.cloudServicesNetworkAttachment}\",\"networkAttachments\":\"{deployParameters.networkAttachments}\",\"sshPublicKeys\":\"{deployParameters.sshPublicKeys}\",\"storageProfile\":\"{deployParameters.storageProfile}\",\"isolateEmulatorThread\":\"{deployParameters.isolateEmulatorThread}\",\"virtioInterface\":\"{deployParameters.virtioInterface}\",\"userData\":\"{deployParameters.userData}\",\"adminUsername\":\"{deployParameters.adminUsername}\",\"bootMethod\":\"{deployParameters.bootMethod}\",\"placementHints\":\"{deployParameters.placementHints}\"}" + }, + "applicationEnablement": "Unknown" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions", + "location": "eastus", + "properties": { + "versionState": "Preview", + "description": "test NFDV for AzureOperatorNexus", + "deployParameters": "{\"virtualMachineName\":{\"type\":\"string\"},\"extendedLocationName\":{\"type\":\"string\"},\"cpuCores\":{\"type\":\"int\"},\"memorySizeGB\":{\"type\":\"int\"},\"cloudServicesNetworkAttachment\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]},\"networkAttachments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]}},\"storageProfile\":{\"type\":\"object\",\"properties\":{\"osDisk\":{\"type\":\"object\",\"properties\":{\"createOption\":{\"type\":\"string\"},\"deleteOption\":{\"type\":\"string\"},\"diskSizeGB\":{\"type\":\"integer\"}},\"required\":[\"diskSizeGB\"]}},\"required\":[\"osDisk\"]},\"sshPublicKeys\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"keyData\":{\"type\":\"string\"}},\"required\":[\"keyData\"]}},\"userData\":{\"type\":\"string\"},\"adminUsername\":{\"type\":\"string\"},\"bootMethod\":{\"type\":\"string\",\"default\":\"UEFI\",\"enum\":[\"UEFI\",\"BIOS\"]},\"isolateEmulatorThread\":{\"type\":\"string\"},\"virtioInterface\":{\"type\":\"string\"},\"placementHints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"hintType\":{\"type\":\"string\",\"enum\":[\"Affinity\",\"AntiAffinity\"]},\"resourceId\":{\"type\":\"string\"},\"schedulingExecution\":{\"type\":\"string\",\"enum\":[\"Soft\",\"Hard\"]},\"scope\":{\"type\":\"string\"}},\"required\":[\"hintType\",\"schedulingExecution\",\"resourceId\",\"scope\"]}}}", + "networkFunctionType": "VirtualNetworkFunction", + "networkFunctionTemplate": { + "nfviType": "AzureOperatorNexus", + "networkFunctionApplications": [ + { + "name": "testImageRole", + "artifactType": "ImageFile", + "dependsOnProfile": { + "installDependsOn": [], + "uninstallDependsOn": [], + "updateDependsOn": [] + }, + "artifactProfile": { + "imageArtifactProfile": { + "imageName": "test-image", + "imageVersion": "1.0.0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "imageMappingRuleProfile": { + "userConfiguration": "" + }, + "applicationEnablement": "Unknown" + } + }, + { + "name": "testTemplateRole", + "artifactType": "ArmTemplate", + "dependsOnProfile": { + "installDependsOn": [ + "testImageRole" + ], + "uninstallDependsOn": [ + "testImageRole" + ], + "updateDependsOn": [ + "testImageRole" + ] + }, + "artifactProfile": { + "templateArtifactProfile": { + "templateName": "test-template", + "templateVersion": "1.0.0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "templateMappingRuleProfile": { + "templateParameters": "{\"virtualMachineName\":\"{deployParameters.virtualMachineName}\",\"extendedLocationName\":\"{deployParameters.extendedLocationName}\",\"cpuCores\":\"{deployParameters.cpuCores}\",\"memorySizeGB\":\"{deployParameters.memorySizeGB}\",\"cloudServicesNetworkAttachment\":\"{deployParameters.cloudServicesNetworkAttachment}\",\"networkAttachments\":\"{deployParameters.networkAttachments}\",\"sshPublicKeys\":\"{deployParameters.sshPublicKeys}\",\"storageProfile\":\"{deployParameters.storageProfile}\",\"isolateEmulatorThread\":\"{deployParameters.isolateEmulatorThread}\",\"virtioInterface\":\"{deployParameters.virtioInterface}\",\"userData\":\"{deployParameters.userData}\",\"adminUsername\":\"{deployParameters.adminUsername}\",\"bootMethod\":\"{deployParameters.bootMethod}\",\"placementHints\":\"{deployParameters.placementHints}\"}" + }, + "applicationEnablement": "Unknown" + } + } + ] + } + } + } + }, + "201": { + "body": { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions", + "location": "eastus", + "properties": { + "versionState": "Preview", + "description": "test NFDV for AzureOperatorNexus", + "deployParameters": "{\"virtualMachineName\":{\"type\":\"string\"},\"extendedLocationName\":{\"type\":\"string\"},\"cpuCores\":{\"type\":\"int\"},\"memorySizeGB\":{\"type\":\"int\"},\"cloudServicesNetworkAttachment\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]},\"networkAttachments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]}},\"storageProfile\":{\"type\":\"object\",\"properties\":{\"osDisk\":{\"type\":\"object\",\"properties\":{\"createOption\":{\"type\":\"string\"},\"deleteOption\":{\"type\":\"string\"},\"diskSizeGB\":{\"type\":\"integer\"}},\"required\":[\"diskSizeGB\"]}},\"required\":[\"osDisk\"]},\"sshPublicKeys\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"keyData\":{\"type\":\"string\"}},\"required\":[\"keyData\"]}},\"userData\":{\"type\":\"string\"},\"adminUsername\":{\"type\":\"string\"},\"bootMethod\":{\"type\":\"string\",\"default\":\"UEFI\",\"enum\":[\"UEFI\",\"BIOS\"]},\"isolateEmulatorThread\":{\"type\":\"string\"},\"virtioInterface\":{\"type\":\"string\"},\"placementHints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"hintType\":{\"type\":\"string\",\"enum\":[\"Affinity\",\"AntiAffinity\"]},\"resourceId\":{\"type\":\"string\"},\"schedulingExecution\":{\"type\":\"string\",\"enum\":[\"Soft\",\"Hard\"]},\"scope\":{\"type\":\"string\"}},\"required\":[\"hintType\",\"schedulingExecution\",\"resourceId\",\"scope\"]}}}", + "networkFunctionType": "VirtualNetworkFunction", + "networkFunctionTemplate": { + "nfviType": "AzureOperatorNexus", + "networkFunctionApplications": [ + { + "name": "testImageRole", + "artifactType": "ImageFile", + "dependsOnProfile": { + "installDependsOn": [], + "uninstallDependsOn": [], + "updateDependsOn": [] + }, + "artifactProfile": { + "imageArtifactProfile": { + "imageName": "test-image", + "imageVersion": "1.0.0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "imageMappingRuleProfile": { + "userConfiguration": "" + }, + "applicationEnablement": "Unknown" + } + }, + { + "name": "testTemplateRole", + "artifactType": "ArmTemplate", + "dependsOnProfile": { + "installDependsOn": [ + "testImageRole" + ], + "uninstallDependsOn": [ + "testImageRole" + ], + "updateDependsOn": [ + "testImageRole" + ] + }, + "artifactProfile": { + "templateArtifactProfile": { + "templateName": "test-template", + "templateVersion": "1.0.0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "templateMappingRuleProfile": { + "templateParameters": "{\"virtualMachineName\":\"{deployParameters.virtualMachineName}\",\"extendedLocationName\":\"{deployParameters.extendedLocationName}\",\"cpuCores\":\"{deployParameters.cpuCores}\",\"memorySizeGB\":\"{deployParameters.memorySizeGB}\",\"cloudServicesNetworkAttachment\":\"{deployParameters.cloudServicesNetworkAttachment}\",\"networkAttachments\":\"{deployParameters.networkAttachments}\",\"sshPublicKeys\":\"{deployParameters.sshPublicKeys}\",\"storageProfile\":\"{deployParameters.storageProfile}\",\"isolateEmulatorThread\":\"{deployParameters.isolateEmulatorThread}\",\"virtioInterface\":\"{deployParameters.virtioInterface}\",\"userData\":\"{deployParameters.userData}\",\"adminUsername\":\"{deployParameters.adminUsername}\",\"bootMethod\":\"{deployParameters.bootMethod}\",\"placementHints\":\"{deployParameters.placementHints}\"}" + }, + "applicationEnablement": "Unknown" + } + } + ] + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionDelete.json new file mode 100644 index 000000000000..60ec045c9af2 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersionName": "1.0.0" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionGet.json new file mode 100644 index 000000000000..17ac5e2980c5 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionGet.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions", + "location": "eastus", + "properties": { + "versionState": "Preview", + "description": "test NFDV for AzureOperatorNexus", + "deployParameters": "{\"virtualMachineName\":{\"type\":\"string\"},\"extendedLocationName\":{\"type\":\"string\"},\"cpuCores\":{\"type\":\"int\"},\"memorySizeGB\":{\"type\":\"int\"},\"cloudServicesNetworkAttachment\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]},\"networkAttachments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]}},\"storageProfile\":{\"type\":\"object\",\"properties\":{\"osDisk\":{\"type\":\"object\",\"properties\":{\"createOption\":{\"type\":\"string\"},\"deleteOption\":{\"type\":\"string\"},\"diskSizeGB\":{\"type\":\"integer\"}},\"required\":[\"diskSizeGB\"]}},\"required\":[\"osDisk\"]},\"sshPublicKeys\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"keyData\":{\"type\":\"string\"}},\"required\":[\"keyData\"]}},\"userData\":{\"type\":\"string\"},\"adminUsername\":{\"type\":\"string\"},\"bootMethod\":{\"type\":\"string\",\"default\":\"UEFI\",\"enum\":[\"UEFI\",\"BIOS\"]},\"isolateEmulatorThread\":{\"type\":\"string\"},\"virtioInterface\":{\"type\":\"string\"},\"placementHints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"hintType\":{\"type\":\"string\",\"enum\":[\"Affinity\",\"AntiAffinity\"]},\"resourceId\":{\"type\":\"string\"},\"schedulingExecution\":{\"type\":\"string\",\"enum\":[\"Soft\",\"Hard\"]},\"scope\":{\"type\":\"string\"}},\"required\":[\"hintType\",\"schedulingExecution\",\"resourceId\",\"scope\"]}}}", + "networkFunctionType": "VirtualNetworkFunction", + "networkFunctionTemplate": { + "nfviType": "AzureOperatorNexus", + "networkFunctionApplications": [ + { + "name": "testImageRole", + "artifactType": "ImageFile", + "dependsOnProfile": { + "installDependsOn": [], + "uninstallDependsOn": [], + "updateDependsOn": [] + }, + "artifactProfile": { + "imageArtifactProfile": { + "imageName": "test-image", + "imageVersion": "1.0.0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "imageMappingRuleProfile": { + "userConfiguration": "" + }, + "applicationEnablement": "Unknown" + } + }, + { + "name": "testTemplateRole", + "artifactType": "ArmTemplate", + "dependsOnProfile": { + "installDependsOn": [ + "testImageRole" + ], + "uninstallDependsOn": [ + "testImageRole" + ], + "updateDependsOn": [ + "testImageRole" + ] + }, + "artifactProfile": { + "templateArtifactProfile": { + "templateName": "test-template", + "templateVersion": "1.0.0" + }, + "artifactStore": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore" + } + }, + "deployParametersMappingRuleProfile": { + "templateMappingRuleProfile": { + "templateParameters": "{\"virtualMachineName\":\"{deployParameters.virtualMachineName}\",\"extendedLocationName\":\"{deployParameters.extendedLocationName}\",\"cpuCores\":\"{deployParameters.cpuCores}\",\"memorySizeGB\":\"{deployParameters.memorySizeGB}\",\"cloudServicesNetworkAttachment\":\"{deployParameters.cloudServicesNetworkAttachment}\",\"networkAttachments\":\"{deployParameters.networkAttachments}\",\"sshPublicKeys\":\"{deployParameters.sshPublicKeys}\",\"storageProfile\":\"{deployParameters.storageProfile}\",\"isolateEmulatorThread\":\"{deployParameters.isolateEmulatorThread}\",\"virtioInterface\":\"{deployParameters.virtioInterface}\",\"userData\":\"{deployParameters.userData}\",\"adminUsername\":\"{deployParameters.adminUsername}\",\"bootMethod\":\"{deployParameters.bootMethod}\",\"placementHints\":\"{deployParameters.placementHints}\"}" + }, + "applicationEnablement": "Unknown" + } + } + ] + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDelete.json new file mode 100644 index 000000000000..a2f57d14a02d --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionGet.json new file mode 100644 index 000000000000..ebe41fc87dc3 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publisherName": "TestPublisher", + "publisherScope": "Private", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.0", + "networkFunctionDefinitionOfferingLocation": "eastus", + "nfviType": "AzureOperatorNexus", + "nfviId": "/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"virtualMachineName\":\"test-VM\",\"extendedLocationName\":\"test-cluster\",\"cpuCores\":4,\"memorySizeGB\":8,\"cloudServicesNetworkAttachment\":{\"attachedNetworkId\":\"test-csnet\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-cs-vlan\"},\"networkAttachments\":[{\"attachedNetworkId\":\"test-l3vlan\",\"defaultGateway\":\"True\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-vlan\"}],\"sshPublicKeys\":[{\"keyData\":\"ssh-rsa CMIIIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0TqlveKKlc2MFvEmuXJiLGBsY1t4ML4uiRADGSZlnc+7Ugv3h+MCjkkwOKiOdsNo8k4KSBIG5GcQfKYOOd17AJvqCL6cGQbaLuqv0a64jeDm8oO8/xN/IM0oKw7rMr/2oAJOgIsfeXPkRxWWic9AVIS++H5Qi2r7bUFX+cqFsyUCAwEBBQ==\"}],\"storageProfile\":{\"osDisk\":{\"createOption\":\"Ephemeral\",\"deleteOption\":\"Delete\",\"diskSizeGB\":10}},\"userData\":\"testUserData\",\"adminUsername\":\"testUser\",\"virtioInterface\":\"Transitional\",\"isolateEmulatorThread\":\"False\",\"bootMethod\":\"BIOS\",\"placementHints\":[]}" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ComponentGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ComponentGet.json new file mode 100644 index 000000000000..eccd32aeeda8 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ComponentGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf", + "componentName": "testComponent" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf/components/testComponent", + "name": "testComponent", + "type": "Microsoft.HybridNetwork/networkFunctions/components", + "properties": { + "provisioningState": "Succeeded", + "deploymentProfile": "{\"chart\":{\"name\":\"testChartName\",\"version\":\"v1.0.0\"},\"releaseName\":\"testReleaseName\",\"targetNamespace\":\"testTargetNameSpace\",\"values\":{\".repoBase\":\"testrepo.azurecr.io/\"}}", + "deploymentStatus": { + "status": "Installing", + "resources": { + "deployments": [ + { + "name": "nginix", + "namespace": "core", + "desired": 3, + "ready": 3, + "upToDate": 3, + "available": 3, + "creationTime": "2023-07-10T02:05:01.116+00:00" + } + ], + "pods": [ + { + "name": "nginix", + "namespace": "core", + "desired": 3, + "ready": 3, + "status": "Succeeded", + "creationTime": "2023-07-10T02:05:01.116+00:00", + "events": [ + { + "type": "Normal", + "reason": "Pulling", + "message": "Pulling image nginx", + "lastSeenTime": "2023-07-10T02:06:01.116+00:00" + } + ] + } + ] + }, + "nextExpectedUpdateAt": "2023-07-10T02:06:01.116+00:00" + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ComponentListByNetworkFunction.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ComponentListByNetworkFunction.json new file mode 100644 index 000000000000..67fa352ff4a5 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ComponentListByNetworkFunction.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf/components/testComponent", + "name": "testComponent", + "type": "Microsoft.HybridNetwork/networkFunctions/components", + "properties": { + "provisioningState": "Succeeded", + "deploymentProfile": "{\"chart\":{\"name\":\"testChartName\",\"version\":\"v1.0.0\"},\"releaseName\":\"testReleaseName\",\"targetNamespace\":\"testTargetNameSpace\",\"values\":{\".repoBase\":\"testrepo.azurecr.io/\"}}", + "deploymentStatus": { + "status": "Installing", + "resources": { + "deployments": [ + { + "name": "nginix", + "namespace": "core", + "desired": 3, + "ready": 3, + "upToDate": 3, + "available": 3, + "creationTime": "2023-07-10T02:05:01.116+00:00" + } + ], + "pods": [ + { + "name": "nginix", + "namespace": "core", + "desired": 3, + "ready": 3, + "status": "Succeeded", + "creationTime": "2023-07-10T02:05:01.116+00:00", + "events": [ + { + "type": "Normal", + "reason": "Pulling", + "message": "Pulling image nginx", + "lastSeenTime": "2023-07-10T02:06:01.116+00:00" + } + ] + } + ] + }, + "nextExpectedUpdateAt": "2023-07-10T02:06:01.116+00:00" + } + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaCreate.json new file mode 100644 index 000000000000..da9dcf910f2d --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaCreate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publisherName": "testPublisher", + "configurationGroupSchemaName": "testConfigurationGroupSchema", + "parameters": { + "location": "westUs2", + "properties": { + "schemaDefinition": "{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}", + "description": "Schema with no secrets" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testConfigurationGroupSchema", + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/interconnectgroupsSchema", + "type": "Microsoft.HybridNetwork/publishers/configurationGroupSchemas", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "properties": { + "provisioningState": "Accepted", + "schemaDefinition": "{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}", + "description": "Schema with no secrets" + } + } + }, + "201": { + "body": { + "name": "testConfigurationGroupSchema", + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/interconnectgroupsSchema", + "type": "Microsoft.HybridNetwork/publishers/configurationGroupSchemas", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "properties": { + "provisioningState": "Accepted", + "schemaDefinition": "{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}", + "description": "Schema with no secrets" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaDelete.json new file mode 100644 index 000000000000..7236ac7fbf1b --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publisherName": "testPublisher", + "configurationGroupSchemaName": "testConfigurationGroupSchema" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaGet.json new file mode 100644 index 000000000000..22d07a6c63d0 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publisherName": "testPublisher", + "configurationGroupSchemaName": "testConfigurationGroupSchema" + }, + "responses": { + "200": { + "body": { + "name": "testConfigurationGroupSchema", + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/interconnectgroupsSchema", + "type": "Microsoft.HybridNetwork/publishers/configurationGroupSchemas", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "properties": { + "provisioningState": "Accepted", + "schemaDefinition": "{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}", + "description": "Schema with no secrets" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaListByPublisherName.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaListByPublisherName.json new file mode 100644 index 000000000000..c289c468811e --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaListByPublisherName.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publisherName": "testPublisher" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConfigurationGroupSchema", + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/interconnectgroupsSchema", + "type": "Microsoft.HybridNetwork/publishers/configurationGroupSchemas", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "properties": { + "provisioningState": "Accepted", + "schemaDefinition": "{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}", + "description": "Schema with no secrets" + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaUpdateTags.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaUpdateTags.json new file mode 100644 index 000000000000..6d5ff43da427 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaUpdateTags.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publisherName": "testPublisher", + "configurationGroupSchemaName": "testConfigurationGroupSchema", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testConfigurationGroupSchema", + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/interconnectgroupsSchema", + "type": "Microsoft.HybridNetwork/publishers/configurationGroupSchemas", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Accepted", + "schemaDefinition": "{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}", + "description": "Schema with no secrets" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaVersionUpdateState.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaVersionUpdateState.json new file mode 100644 index 000000000000..f735294332ca --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaVersionUpdateState.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publisherName": "testPublisher", + "configurationGroupSchemaName": "testConfigurationGroupSchema", + "parameters": { + "versionState": "Active" + } + }, + "responses": { + "200": { + "body": { + "versionState": "Active" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueCreate.json new file mode 100644 index 000000000000..b82857c34577 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueCreate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "configurationGroupValueName": "testConfigurationGroupValue", + "parameters": { + "location": "eastus", + "properties": { + "configurationGroupSchemaResourceReference": { + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName", + "idType": "Open" + }, + "configurationType": "Open", + "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testConfigurationGroupValue", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue", + "type": "Microsoft.HybridNetwork/configurationGroupValues", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testPublisher", + "publisherScope": "Public", + "configurationGroupSchemaName": "testConfigurationGroupSchemaName", + "configurationGroupSchemaOfferingLocation": "eastus", + "configurationType": "Open", + "configurationGroupSchemaResourceReference": { + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName", + "idType": "Open" + }, + "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}" + } + } + }, + "201": { + "body": { + "name": "testConfigurationGroup", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroups/testConfigurationGroup", + "type": "Microsoft.HybridNetwork/configurationGroups", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testPublisher", + "publisherScope": "Public", + "configurationGroupSchemaName": "testConfigurationGroupSchemaName", + "configurationGroupSchemaOfferingLocation": "eastus", + "configurationGroupSchemaResourceReference": { + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName", + "idType": "Open" + }, + "configurationType": "Open", + "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueCreateSecret.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueCreateSecret.json new file mode 100644 index 000000000000..bd3a4d410d43 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueCreateSecret.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "configurationGroupValueName": "testConfigurationGroupValue", + "parameters": { + "location": "eastus", + "properties": { + "configurationGroupSchemaResourceReference": { + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName", + "idType": "Open" + }, + "configurationType": "Secret", + "secretConfigurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testConfigurationGroupValue", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue", + "type": "Microsoft.HybridNetwork/configurationGroupValues", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testPublisher", + "publisherScope": "Public", + "configurationGroupSchemaName": "testConfigurationGroupSchemaName", + "configurationGroupSchemaOfferingLocation": "eastus", + "configurationType": "Secret", + "configurationGroupSchemaResourceReference": { + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName", + "idType": "Open" + } + } + } + }, + "201": { + "body": { + "name": "testConfigurationGroup", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroups/testConfigurationGroup", + "type": "Microsoft.HybridNetwork/configurationGroups", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testPublisher", + "publisherScope": "Public", + "configurationGroupSchemaName": "testConfigurationGroupSchemaName", + "configurationGroupSchemaOfferingLocation": "eastus", + "configurationType": "Secret", + "configurationGroupSchemaResourceReference": { + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName", + "idType": "Open" + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueDelete.json new file mode 100644 index 000000000000..5a1c06081534 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "configurationGroupValueName": "testConfigurationGroupValue" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueFirstPartyCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueFirstPartyCreate.json new file mode 100644 index 000000000000..b4c25a235cf6 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueFirstPartyCreate.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "configurationGroupValueName": "testConfigurationGroupValue", + "parameters": { + "location": "eastus", + "properties": { + "configurationGroupSchemaResourceReference": { + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName", + "idType": "Secret" + }, + "configurationType": "Open", + "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testConfigurationGroupValue", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue", + "type": "Microsoft.HybridNetwork/configurationGroupValues", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testPublisher", + "publisherScope": "Private", + "configurationGroupSchemaName": "testConfigurationGroupSchemaName", + "configurationGroupSchemaOfferingLocation": "eastus", + "configurationType": "Open", + "configurationGroupSchemaResourceReference": { + "idType": "Secret" + }, + "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}" + } + } + }, + "201": { + "body": { + "name": "testConfigurationGroup", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroups/testConfigurationGroup", + "type": "Microsoft.HybridNetwork/configurationGroups", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testPublisher", + "publisherScope": "Private", + "configurationGroupSchemaName": "testConfigurationGroupSchemaName", + "configurationGroupSchemaOfferingLocation": "eastus", + "configurationType": "Open", + "configurationGroupSchemaResourceReference": { + "idType": "Secret" + }, + "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueGet.json new file mode 100644 index 000000000000..b3312001edb6 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "configurationGroupValueName": "testConfigurationGroupValue" + }, + "responses": { + "200": { + "body": { + "name": "testConfigurationGroupValue", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue", + "type": "Microsoft.HybridNetwork/configurationGroupValues", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testPublisher", + "publisherScope": "Private", + "configurationGroupSchemaName": "testConfigurationGroupSchemaName", + "configurationGroupSchemaOfferingLocation": "eastus", + "configurationGroupSchemaResourceReference": { + "idType": "Open", + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName" + }, + "configurationType": "Open", + "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueListByResourceGroup.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueListByResourceGroup.json new file mode 100644 index 000000000000..3b48a9072562 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConfigurationGroupValue", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue", + "type": "Microsoft.HybridNetwork/configurationGroupValues", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "properties": { + "publisherName": "testPublisher", + "publisherScope": "Public", + "configurationGroupSchemaName": "testConfigurationGroupSchemaName", + "configurationGroupSchemaResourceReference": { + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName", + "idType": "Open" + }, + "configurationType": "Open", + "configurationGroupSchemaOfferingLocation": "eastus", + "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}" + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueListBySubscription.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueListBySubscription.json new file mode 100644 index 000000000000..70879bc9d663 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueListBySubscription.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConfigurationGroupValue", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue", + "type": "Microsoft.HybridNetwork/configurationGroupValues", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "publisherName": "testPublisher", + "publisherScope": "Public", + "configurationGroupSchemaName": "testConfigurationGroupSchemaName", + "configurationGroupSchemaResourceReference": { + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName", + "idType": "Open" + }, + "configurationType": "Open", + "configurationGroupSchemaOfferingLocation": "eastus", + "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}" + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueUpdateTags.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueUpdateTags.json new file mode 100644 index 000000000000..528df08c1134 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueUpdateTags.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "configurationGroupValueName": "testConfigurationGroupValue", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testConfigurationGroupValue", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue", + "type": "Microsoft.HybridNetwork/configurationGroupValues", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testPublisher", + "publisherScope": "Public", + "configurationGroupSchemaName": "testConfigurationGroupSchemaName", + "configurationGroupSchemaOfferingLocation": "eastus", + "configurationType": "Open", + "configurationGroupSchemaResourceReference": { + "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName", + "idType": "Open" + }, + "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/GetOperations.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/GetOperations.json new file mode 100644 index 000000000000..560738e8b6b5 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/GetOperations.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2023-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.HybridNetwork/NetworkFunctions/read", + "display": { + "provider": "Microsoft Hybrid Network", + "resource": "Nf", + "operation": "Get Nf", + "description": "Gets Nf" + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionCreate.json new file mode 100644 index 000000000000..2f00f0747d4a --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionCreate.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf", + "parameters": { + "location": "eastus", + "properties": { + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviType": "AzureArcKubernetes", + "nfviId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}", + "roleOverrideValues": [ + "{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}", + "{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testVendor", + "publisherScope": "Public", + "networkFunctionDefinitionGroupName": "testnetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.1", + "networkFunctionDefinitionOfferingLocation": "eastus", + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviType": "AzureArcKubernetes", + "nfviId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}", + "roleOverrideValues": [ + "{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}", + "{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Accepted", + "publisherName": "testVendor", + "publisherScope": "Public", + "networkFunctionDefinitionGroupName": "testnetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.1", + "networkFunctionDefinitionOfferingLocation": "eastus", + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviType": "AzureArcKubernetes", + "nfviId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}", + "roleOverrideValues": [ + "{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}", + "{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}" + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionCreateSecret.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionCreateSecret.json new file mode 100644 index 000000000000..17d9b5522c35 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionCreateSecret.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf", + "parameters": { + "location": "eastus", + "properties": { + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviType": "AzureArcKubernetes", + "nfviId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Secret", + "secretDeploymentValues": "{\"adminPassword\":\"password1\",\"userPassword\":\"password2\"}", + "roleOverrideValues": [ + "{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}", + "{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testVendor", + "publisherScope": "Public", + "networkFunctionDefinitionGroupName": "testnetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.1", + "networkFunctionDefinitionOfferingLocation": "eastus", + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviType": "AzureArcKubernetes", + "nfviId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Secret", + "roleOverrideValues": [ + "{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}", + "{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Accepted", + "publisherName": "testVendor", + "publisherScope": "Public", + "networkFunctionDefinitionGroupName": "testnetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.1", + "networkFunctionDefinitionOfferingLocation": "eastus", + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviType": "AzureArcKubernetes", + "nfviId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Secret", + "roleOverrideValues": [ + "{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}", + "{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}" + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupCreate.json new file mode 100644 index 000000000000..d6f200106f09 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupCreate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "TestPublisherSkuVersion", + "id": "/subscriptions/subid/resourcegroups/rg/rgproviders/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups", + "location": "eastus", + "properties": {} + } + }, + "201": { + "body": { + "name": "TestPublisherSkuVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups", + "location": "eastus", + "properties": {} + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupDelete.json new file mode 100644 index 000000000000..a2d16aabdd4b --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupGet.json new file mode 100644 index 000000000000..739074d11177 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName" + }, + "responses": { + "200": { + "body": { + "name": "TestNetworkFunctionDefinitionVersion", + "id": "/subscriptions/subid/resourcegroups/rg/rgproviders/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups", + "location": "eastus", + "properties": { + "description": "Test NFD group" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupUpdateTags.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupUpdateTags.json new file mode 100644 index 000000000000..fa5076b2f611 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupUpdateTags.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestPublisherSkuVersion", + "id": "/subscriptions/subid/resourcegroups/rg/rgproviders/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": {} + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupsListByPublisherName.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupsListByPublisherName.json new file mode 100644 index 000000000000..c26b0662a5b2 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupsListByPublisherName.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestNetworkFunctionDefinitionVersion", + "id": "/subscriptions/subid/resourcegroups/rg/rgproviders/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups", + "location": "eastus", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionCreate.json new file mode 100644 index 000000000000..c4f70b8fe8a6 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionCreate.json @@ -0,0 +1,196 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersionName": "1.0.0", + "parameters": { + "location": "eastus", + "properties": { + "versionState": "Active", + "deployParameters": "{\"type\":\"object\",\"properties\":{\"releaseName\":{\"type\":\"string\"},\"namespace\":{\"type\":\"string\"}}}", + "networkFunctionType": "ContainerizedNetworkFunction", + "networkFunctionTemplate": { + "nfviType": "AzureArcKubernetes", + "networkFunctionApplications": [ + { + "name": "fedrbac", + "artifactType": "HelmPackage", + "dependsOnProfile": { + "installDependsOn": [], + "uninstallDependsOn": [], + "updateDependsOn": [] + }, + "artifactProfile": { + "artifactStore": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/testArtifactStore" + }, + "helmArtifactProfile": { + "helmPackageName": "fed-rbac", + "helmPackageVersionRange": "~2.1.3", + "registryValuesPaths": [ + "global.registry.docker.repoPath" + ], + "imagePullSecretsValuesPaths": [ + "global.imagePullSecrets" + ] + } + }, + "deployParametersMappingRuleProfile": { + "applicationEnablement": "Enabled", + "helmMappingRuleProfile": { + "releaseNamespace": "{deployParameters.namesapce}", + "releaseName": "{deployParameters.releaseName}", + "helmPackageVersion": "2.1.3", + "values": "", + "options": { + "installOptions": { + "atomic": "true", + "wait": "waitValue", + "timeout": "30" + }, + "upgradeOptions": { + "atomic": "true", + "wait": "waitValue", + "timeout": "30" + } + } + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions", + "location": "eastus", + "properties": { + "versionState": "Active", + "deployParameters": "{\"type\":\"object\",\"properties\":{\"releaseName\":{\"type\":\"string\"},\"namespace\":{\"type\":\"string\"}}}", + "networkFunctionType": "ContainerizedNetworkFunction", + "networkFunctionTemplate": { + "nfviType": "AzureArcKubernetes", + "networkFunctionApplications": [ + { + "name": "fedrbac", + "artifactType": "HelmPackage", + "dependsOnProfile": { + "installDependsOn": [], + "uninstallDependsOn": [], + "updateDependsOn": [] + }, + "artifactProfile": { + "artifactStore": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/artifactStores/testStore" + }, + "helmArtifactProfile": { + "helmPackageName": "fed-rbac", + "helmPackageVersionRange": "~2.1.3", + "registryValuesPaths": [ + "global.registry.docker.repoPath" + ], + "imagePullSecretsValuesPaths": [ + "global.imagePullSecrets" + ] + } + }, + "deployParametersMappingRuleProfile": { + "applicationEnablement": "Enabled", + "helmMappingRuleProfile": { + "releaseNamespace": "{deployParameters.namesapce}", + "releaseName": "{deployParameters.releaseName}", + "helmPackageVersion": "2.1.3", + "values": "", + "options": { + "installOptions": { + "atomic": "true", + "wait": "waitValue", + "timeout": "30" + }, + "upgradeOptions": { + "atomic": "true", + "wait": "waitValue", + "timeout": "30" + } + } + } + } + } + ] + } + } + } + }, + "201": { + "body": { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions", + "location": "eastus", + "properties": { + "versionState": "Active", + "deployParameters": "{\"type\":\"object\",\"properties\":{\"releaseName\":{\"type\":\"string\"},\"namespace\":{\"type\":\"string\"}}}", + "networkFunctionType": "ContainerizedNetworkFunction", + "networkFunctionTemplate": { + "nfviType": "AzureArcKubernetes", + "networkFunctionApplications": [ + { + "name": "fedrbac", + "artifactType": "HelmPackage", + "dependsOnProfile": { + "installDependsOn": [], + "uninstallDependsOn": [], + "updateDependsOn": [] + }, + "artifactProfile": { + "artifactStore": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/testArtifactStore" + }, + "helmArtifactProfile": { + "helmPackageName": "fed-rbac", + "helmPackageVersionRange": "~2.1.3", + "registryValuesPaths": [ + "global.registry.docker.repoPath" + ], + "imagePullSecretsValuesPaths": [ + "global.imagePullSecrets" + ] + } + }, + "deployParametersMappingRuleProfile": { + "applicationEnablement": "Enabled", + "helmMappingRuleProfile": { + "releaseNamespace": "{deployParameters.namesapce}", + "releaseName": "{deployParameters.releaseName}", + "helmPackageVersion": "2.1.3", + "values": "", + "options": { + "installOptions": { + "atomic": "true", + "wait": "waitValue", + "timeout": "30" + }, + "upgradeOptions": { + "atomic": "true", + "wait": "waitValue", + "timeout": "30" + } + } + } + } + } + ] + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionDelete.json new file mode 100644 index 000000000000..60ec045c9af2 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersionName": "1.0.0" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionGet.json new file mode 100644 index 000000000000..3ceff2191e64 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionGet.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions", + "location": "eastus", + "properties": { + "versionState": "Active", + "deployParameters": "{\"releaseName\":{\"type\":\"string\"},\"namespace\":{\"type\":\"string\"}}", + "networkFunctionType": "ContainerizedNetworkFunction", + "networkFunctionTemplate": { + "nfviType": "AzureArcKubernetes", + "networkFunctionApplications": [ + { + "name": "fedrbac", + "artifactType": "HelmPackage", + "dependsOnProfile": { + "installDependsOn": [], + "uninstallDependsOn": [], + "updateDependsOn": [] + }, + "artifactProfile": { + "artifactStore": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/testArtifactStore" + }, + "helmArtifactProfile": { + "helmPackageName": "fed-rbac", + "helmPackageVersionRange": "~2.1.3", + "registryValuesPaths": [ + "global.registry.docker.repoPath" + ], + "imagePullSecretsValuesPaths": [ + "global.imagePullSecrets" + ] + } + }, + "deployParametersMappingRuleProfile": { + "applicationEnablement": "Enabled", + "helmMappingRuleProfile": { + "releaseNamespace": "{deployParameters.namesapce}", + "releaseName": "{deployParameters.releaseName}", + "helmPackageVersion": "2.1.3", + "values": "" + } + } + } + ] + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionListByNetworkFunctionDefinitionGroup.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionListByNetworkFunctionDefinitionGroup.json new file mode 100644 index 000000000000..c5e02671ed7c --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionListByNetworkFunctionDefinitionGroup.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupNameName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "networkFunctionDefinitionVersionName", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/publisherskuGroups/networkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/TestVersion", + "type": "Microsoft.HybridNetwork/publishers/publisherskugroups/publisherskuversions", + "location": "eastus", + "properties": { + "versionState": "Active", + "deployParameters": "{\"releaseName\":{\"type\":\"string\"},\"namespace\":{\"type\":\"string\"}}", + "networkFunctionType": "ContainerizedNetworkFunction", + "networkFunctionTemplate": { + "nfviType": "AzureArcKubernetes", + "networkFunctionApplications": [ + { + "name": "fedrbac", + "artifactType": "HelmPackage", + "dependsOnProfile": { + "installDependsOn": [], + "uninstallDependsOn": [], + "updateDependsOn": [] + }, + "artifactProfile": { + "artifactStore": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/testArtifactStore" + }, + "helmArtifactProfile": { + "helmPackageName": "fed-rbac", + "helmPackageVersionRange": "~2.1.3", + "registryValuesPaths": [ + "global.registry.docker.repoPath" + ], + "imagePullSecretsValuesPaths": [ + "global.imagePullSecrets" + ] + } + }, + "deployParametersMappingRuleProfile": { + "applicationEnablement": "Enabled", + "helmMappingRuleProfile": { + "releaseNamespace": "{deployParameters.namesapce}", + "releaseName": "{deployParameters.releaseName}", + "helmPackageVersion": "2.1.3", + "values": "", + "options": { + "installOptions": { + "atomic": "true", + "wait": "waitValue", + "timeout": "30" + }, + "upgradeOptions": { + "atomic": "true", + "wait": "waitValue", + "timeout": "30" + } + } + } + } + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionUpdateState.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionUpdateState.json new file mode 100644 index 000000000000..a6c827e66b92 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionUpdateState.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestSkuGroup", + "networkFunctionDefinitionVersionName": "1.0.0", + "parameters": { + "versionState": "Active" + } + }, + "responses": { + "200": { + "body": { + "versionState": "Active" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionUpdateTags.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionUpdateTags.json new file mode 100644 index 000000000000..a31feac68b33 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionUpdateTags.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkFunctionDefinitionGroupName": "TestNetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersionName": "1.0.0", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "versionState": "Active", + "deployParameters": "{\"releaseName\":{\"type\":\"string\"},\"namespace\":{\"type\":\"string\"}}", + "networkFunctionType": "ContainerizedNetworkFunction", + "networkFunctionTemplate": { + "nfviType": "AzureArcKubernetes", + "networkFunctionApplications": [ + { + "name": "fedrbac", + "artifactType": "HelmPackage", + "dependsOnProfile": { + "installDependsOn": [], + "uninstallDependsOn": [], + "updateDependsOn": [] + }, + "artifactProfile": { + "artifactStore": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/testArtifactStore" + }, + "helmArtifactProfile": { + "helmPackageName": "fed-rbac", + "helmPackageVersionRange": "~2.1.3", + "registryValuesPaths": [ + "global.registry.docker.repoPath" + ], + "imagePullSecretsValuesPaths": [ + "global.imagePullSecrets" + ] + } + }, + "deployParametersMappingRuleProfile": { + "applicationEnablement": "Enabled", + "helmMappingRuleProfile": { + "releaseNamespace": "{deployParameters.namesapce}", + "releaseName": "{deployParameters.releaseName}", + "helmPackageVersion": "2.1.3", + "values": "" + } + } + } + ] + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDelete.json new file mode 100644 index 000000000000..a2f57d14a02d --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionFirstPartyCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionFirstPartyCreate.json new file mode 100644 index 000000000000..addf239dd772 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionFirstPartyCreate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf", + "parameters": { + "location": "eastus", + "properties": { + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Secret" + }, + "nfviType": "AzureArcKubernetes", + "nfviId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}", + "roleOverrideValues": [ + "{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}", + "{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testVendor", + "publisherScope": "Public", + "networkFunctionDefinitionGroupName": "testnetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.1", + "networkFunctionDefinitionOfferingLocation": "eastus", + "networkFunctionDefinitionVersionResourceReference": { + "idType": "Secret" + }, + "nfviType": "AzureArcKubernetes", + "nfviId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}", + "roleOverrideValues": [ + "{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}", + "{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Accepted", + "publisherName": "testVendor", + "publisherScope": "Public", + "networkFunctionDefinitionGroupName": "testnetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.1", + "networkFunctionDefinitionOfferingLocation": "eastus", + "networkFunctionDefinitionVersionResourceReference": { + "idType": "Secret" + }, + "nfviType": "AzureArcKubernetes", + "nfviId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "deploymentValues": "{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}", + "configurationType": "Open", + "roleOverrideValues": [ + "{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}", + "{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}" + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionGet.json new file mode 100644 index 000000000000..97cd17803fbb --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testVendor", + "publisherScope": "Public", + "networkFunctionDefinitionGroupName": "testnetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.1", + "networkFunctionDefinitionOfferingLocation": "eastus", + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviType": "AzureArcKubernetes", + "nfviId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}", + "roleOverrideValues": [ + "{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}", + "{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}" + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionListByResourceGroup.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionListByResourceGroup.json new file mode 100644 index 000000000000..70f1f1918718 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testVendor", + "publisherScope": "Public", + "networkFunctionDefinitionGroupName": "testnetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.1", + "networkFunctionDefinitionOfferingLocation": "eastus", + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviType": "AzureArcKubernetes", + "nfviId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}", + "roleOverrideValues": [ + "{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}", + "{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}" + ] + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionListBySubscription.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionListBySubscription.json new file mode 100644 index 000000000000..1125838252aa --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionListBySubscription.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testVendor", + "publisherScope": "Public", + "networkFunctionDefinitionGroupName": "testnetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.1", + "networkFunctionDefinitionOfferingLocation": "eastus", + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviType": "AzureArcKubernetes", + "nfviId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}", + "roleOverrideValues": [ + "{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}", + "{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}" + ] + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionUpdateTags.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionUpdateTags.json new file mode 100644 index 000000000000..8d4e1deb1248 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionUpdateTags.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "publisherName": "testVendor", + "publisherScope": "Public", + "networkFunctionDefinitionGroupName": "testnetworkFunctionDefinitionGroupName", + "networkFunctionDefinitionVersion": "1.0.1", + "networkFunctionDefinitionOfferingLocation": "eastus", + "networkFunctionDefinitionVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1", + "idType": "Open" + }, + "nfviType": "AzureArcKubernetes", + "nfviId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation", + "allowSoftwareUpdate": false, + "configurationType": "Open", + "deploymentValues": "{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}", + "roleOverrideValues": [ + "{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}", + "{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}" + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionsExecuteRequest.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionsExecuteRequest.json new file mode 100644 index 000000000000..da0fe97ecef5 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionsExecuteRequest.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNetworkfunction", + "parameters": { + "serviceEndpoint": "serviceEndpoint", + "requestMetadata": { + "relativePath": "/simProfiles/testSimProfile", + "httpMethod": "Post", + "serializedBody": "{\"subscriptionProfile\":\"ChantestSubscription15\",\"permanentKey\":\"00112233445566778899AABBCCDDEEFF\",\"opcOperatorCode\":\"63bfa50ee6523365ff14c1f45f88737d\",\"staticIpAddresses\":{\"internet\":{\"ipv4Addr\":\"198.51.100.1\",\"ipv6Prefix\":\"2001:db8:abcd:12::0/64\"},\"another_network\":{\"ipv6Prefix\":\"2001:111:cdef:22::0/64\"}}}", + "apiVersion": "apiVersionQueryString" + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupCreate.json new file mode 100644 index 000000000000..e3e22a298d7b --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupCreate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkServiceDesignGroupName": "TestNetworkServiceDesignGroupName", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "TestNetworkServiceDesignGroupName", + "id": "/subscriptions/subid/resourcegroups/rg/rgproviders/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName", + "type": "Microsoft.HybridNetwork/publishers/networkServiceDesignGroups", + "location": "eastus", + "properties": { + "description": "Test NSD group" + } + } + }, + "201": { + "body": { + "name": "TestNetworkServiceDesignGroupName", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName", + "type": "Microsoft.HybridNetwork/publishers/networkServiceDesignGroups", + "location": "eastus", + "properties": { + "description": "Test NSD group" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupDelete.json new file mode 100644 index 000000000000..750ebdf20a3d --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkServiceDesignGroupName": "TestNetworkServiceDesignGroupName" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupGet.json new file mode 100644 index 000000000000..8fd530626e9b --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkServiceDesignGroupName": "TestNetworkServiceDesignGroupName" + }, + "responses": { + "200": { + "body": { + "name": "TestNetworkServiceDesignGroupName", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName", + "type": "Microsoft.HybridNetwork/publishers/networkServiceDesignGroups", + "location": "eastus", + "properties": { + "description": "Test NSD group" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupUpdateTags.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupUpdateTags.json new file mode 100644 index 000000000000..e860d306c185 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkServiceDesignGroupName": "TestNetworkServiceDesignGroupName", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestNetworkServiceDesignGroupName", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName", + "type": "Microsoft.HybridNetwork/publishers/networkServiceDesignGroups", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Test NSD group" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupsListByPublisherName.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupsListByPublisherName.json new file mode 100644 index 000000000000..6d77c3e9b5af --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupsListByPublisherName.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestNetworkServiceDesignGroupName", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName", + "type": "Microsoft.HybridNetwork/publishers/networkServiceDesignGroups", + "location": "eastus", + "properties": { + "description": "Test NSD group" + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionCreate.json new file mode 100644 index 000000000000..829eee3f885a --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionCreate.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkServiceDesignGroupName": "TestNetworkServiceDesignGroupName", + "networkServiceDesignVersionName": "1.0.0", + "parameters": { + "location": "eastus", + "properties": { + "versionState": "Active", + "configurationGroupSchemaReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/publishers/contosoGroup/networkServiceDesignGroups/NSD_contoso/configurationGroupSchemas/MyVM_Configuration_Schema" + } + }, + "resourceElementTemplates": [ + { + "name": "MyVM", + "type": "ArmResourceDefinition", + "dependsOnProfile": { + "installDependsOn": [] + }, + "configuration": { + "templateType": "ArmTemplate", + "parameterValues": "{\"publisherName\":\"{configurationparameters('MyVM_Configuration').publisherName}\",\"skuGroupName\":\"{configurationparameters('MyVM_Configuration').skuGroupName}\",\"skuVersion\":\"{configurationparameters('MyVM_Configuration').skuVersion}\",\"skuOfferingLocation\":\"{configurationparameters('MyVM_Configuration').skuOfferingLocation}\",\"nfviType\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviType}\",\"nfviId\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviId}\",\"allowSoftwareUpdates\":\"{configurationparameters('MyVM_Configuration').allowSoftwareUpdates}\",\"virtualNetworkName\":\"{configurationparameters('MyVM_Configuration').vnetName}\",\"subnetName\":\"{configurationparameters('MyVM_Configuration').subnetName}\",\"subnetAddressPrefix\":\"{configurationparameters('MyVM_Configuration').subnetAddressPrefix}\",\"managedResourceGroup\":\"{configurationparameters('SNSSelf').managedResourceGroupName}\",\"adminPassword\":\"{secretparameters('MyVM_Configuration').adminPassword}\"}", + "artifactProfile": { + "artifactStoreReference": { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/publishers/contosoGroup/artifactStoreReference/store1" + }, + "artifactName": "MyVMArmTemplate", + "artifactVersion": "1.0.0" + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkServiceDesignGroups/networkServiceDesignVersions", + "location": "eastus", + "properties": { + "versionState": "Active", + "configurationGroupSchemaReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/publishers/contosoGroup/networkServiceDesignGroups/NSD_contoso/configurationGroupSchemas/MyVM_Configuration_Schema" + } + }, + "resourceElementTemplates": [ + { + "name": "MyVM", + "type": "ArmResourceDefinition", + "dependsOnProfile": { + "installDependsOn": [] + }, + "configuration": { + "templateType": "ArmTemplate", + "parameterValues": "{\"publisherName\":\"{configurationparameters('MyVM_Configuration').publisherName}\",\"skuGroupName\":\"{configurationparameters('MyVM_Configuration').skuGroupName}\",\"skuVersion\":\"{configurationparameters('MyVM_Configuration').skuVersion}\",\"skuOfferingLocation\":\"{configurationparameters('MyVM_Configuration').skuOfferingLocation}\",\"nfviType\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviType}\",\"nfviId\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviId}\",\"allowSoftwareUpdates\":\"{configurationparameters('MyVM_Configuration').allowSoftwareUpdates}\",\"virtualNetworkName\":\"{configurationparameters('MyVM_Configuration').vnetName}\",\"subnetName\":\"{configurationparameters('MyVM_Configuration').subnetName}\",\"subnetAddressPrefix\":\"{configurationparameters('MyVM_Configuration').subnetAddressPrefix}\",\"managedResourceGroup\":\"{configurationparameters('SNSSelf').managedResourceGroupName}\",\"adminPassword\":\"{secretparameters('MyVM_Configuration').adminPassword}\"}", + "artifactProfile": { + "artifactStoreReference": { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/publishers/contosoGroup/artifactStoreReference/store1" + }, + "artifactName": "MyVMArmTemplate", + "artifactVersion": "1.0.0" + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions", + "location": "eastus", + "properties": { + "versionState": "Active", + "configurationGroupSchemaReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/publishers/contosoGroup/networkServiceDesignGroups/NSD_contoso/configurationGroupSchemas/MyVM_Configuration_Schema" + } + }, + "resourceElementTemplates": [ + { + "name": "MyVM", + "type": "ArmResourceDefinition", + "dependsOnProfile": { + "installDependsOn": [] + }, + "configuration": { + "templateType": "ArmTemplate", + "parameterValues": "{\"publisherName\":\"{configurationparameters('MyVM_Configuration').publisherName}\",\"skuGroupName\":\"{configurationparameters('MyVM_Configuration').skuGroupName}\",\"skuVersion\":\"{configurationparameters('MyVM_Configuration').skuVersion}\",\"skuOfferingLocation\":\"{configurationparameters('MyVM_Configuration').skuOfferingLocation}\",\"nfviType\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviType}\",\"nfviId\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviId}\",\"allowSoftwareUpdates\":\"{configurationparameters('MyVM_Configuration').allowSoftwareUpdates}\",\"virtualNetworkName\":\"{configurationparameters('MyVM_Configuration').vnetName}\",\"subnetName\":\"{configurationparameters('MyVM_Configuration').subnetName}\",\"subnetAddressPrefix\":\"{configurationparameters('MyVM_Configuration').subnetAddressPrefix}\",\"managedResourceGroup\":\"{configurationparameters('SNSSelf').managedResourceGroupName}\",\"adminPassword\":\"{secretparameters('MyVM_Configuration').adminPassword}\"}", + "artifactProfile": { + "artifactStoreReference": { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/publishers/contosoGroup/artifactStoreReference/store1" + }, + "artifactName": "MyVMArmTemplate", + "artifactVersion": "1.0.0" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionDelete.json new file mode 100644 index 000000000000..10b8e71b0c52 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkServiceDesignGroupName": "TestNetworkServiceDesignGroupName", + "networkServiceDesignVersionName": "1.0.0" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionGet.json new file mode 100644 index 000000000000..9c88c62c42cd --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionGet.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkServiceDesignGroupName": "TestNetworkServiceDesignGroupName", + "networkServiceDesignVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkServiceDesignGroups/networkServiceDesignVersions", + "location": "eastus", + "properties": { + "versionState": "Active", + "configurationGroupSchemaReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/publishers/contosoGroup/networkServiceDesignGroups/NSD_contoso/configurationGroupSchemas/MyVM_Configuration_Schema" + } + }, + "nfvisFromSite": { + "nfvi1": { + "name": "{configurationparameter('MyVM_Configuration').nfviNameFromSite}", + "type": "AzureCore" + } + }, + "resourceElementTemplates": [ + { + "name": "MyVM", + "type": "ArmResourceDefinition", + "dependsOnProfile": { + "installDependsOn": [] + }, + "configuration": { + "templateType": "ArmTemplate", + "parameterValues": "{\"publisherName\":\"{configurationparameters('MyVM_Configuration').publisherName}\",\"skuGroupName\":\"{configurationparameters('MyVM_Configuration').skuGroupName}\",\"skuVersion\":\"{configurationparameters('MyVM_Configuration').skuVersion}\",\"skuOfferingLocation\":\"{configurationparameters('MyVM_Configuration').skuOfferingLocation}\",\"nfviType\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviType}\",\"nfviId\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviId}\",\"allowSoftwareUpdates\":\"{configurationparameters('MyVM_Configuration').allowSoftwareUpdates}\",\"virtualNetworkName\":\"{configurationparameters('MyVM_Configuration').vnetName}\",\"subnetName\":\"{configurationparameters('MyVM_Configuration').subnetName}\",\"subnetAddressPrefix\":\"{configurationparameters('MyVM_Configuration').subnetAddressPrefix}\",\"managedResourceGroup\":\"{configurationparameters('SNSSelf').managedResourceGroupName}\",\"adminPassword\":\"{secretparameters('MyVM_Configuration').adminPassword}\"}", + "artifactProfile": { + "artifactStoreReference": { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/publishers/contosoGroup/ArtifactStore/store1" + }, + "artifactName": "MyVMArmTemplate", + "artifactVersion": "1.0.0" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionListByNetworkServiceDesignGroup.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionListByNetworkServiceDesignGroup.json new file mode 100644 index 000000000000..cb406efb4449 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionListByNetworkServiceDesignGroup.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkServiceDesignGroupName": "TestNetworkServiceDesignGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkServiceDesignGroups/networkServiceDesignVersions", + "location": "eastus", + "properties": { + "versionState": "Active", + "configurationGroupSchemaReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/publishers/contosoGroup/networkServiceDesignGroups/NSD_contoso/configurationGroupSchemas/MyVM_Configuration_Schema" + } + }, + "resourceElementTemplates": [ + { + "name": "MyVM", + "type": "ArmResourceDefinition", + "dependsOnProfile": { + "installDependsOn": [] + }, + "configuration": { + "templateType": "ArmTemplate", + "parameterValues": "\"publisherName\": \"{configurationparameters('MyVM_Configuration').publisherName}\",\r\n \"skuGroupName\": \"{configurationparameters('MyVM_Configuration').skuGroupName}\",\r\n \"skuVersion\": \"{configurationparameters('MyVM_Configuration').skuVersion}\",\r\n \"skuOfferingLocation\": \"{configurationparameters('MyVM_Configuration').skuOfferingLocation}\",\r\n \"nfviType\": \"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviType}\",\r\n \"nfviId\": \"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviId}\",\r\n \"allowSoftwareUpdates\": \"{configurationparameters('MyVM_Configuration').allowSoftwareUpdates}\",\r\n \"virtualNetworkName\": \"{configurationparameters('MyVM_Configuration').vnetName}\",\r\n \"subnetName\": \"{configurationparameters('MyVM_Configuration').subnetName}\",\r\n \"subnetAddressPrefix\": \"{configurationparameters('MyVM_Configuration').subnetAddressPrefix}\",\r\n \"managedResourceGroup\": \"{configurationparameters('SNSSelf').managedResourceGroupName}\"\r\n ", + "artifactProfile": { + "artifactStoreReference": { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/publishers/contosoGroup/ArtifactStore/store1" + }, + "artifactName": "MyVMArmTemplate", + "artifactVersion": "1.0.0" + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionUpdateState.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionUpdateState.json new file mode 100644 index 000000000000..1af9745338b7 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionUpdateState.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkServiceDesignGroupName": "TestNetworkServiceDesignGroupName", + "networkServiceDesignVersionName": "1.0.0", + "parameters": { + "versionState": "Active" + } + }, + "responses": { + "200": { + "body": { + "versionState": "Active" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionUpdateTags.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionUpdateTags.json new file mode 100644 index 000000000000..09fff802b726 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionUpdateTags.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "networkServiceDesignGroupName": "TestNetworkServiceDesignGroupName", + "networkServiceDesignVersionName": "1.0.0", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestVersion", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/networkServiceDesignGroups/networkServiceDesignVersions", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "versionState": "Active", + "configurationGroupSchemaReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/publishers/contosoGroup/networkServiceDesignGroups/NSD_contoso/configurationGroupSchemas/MyVM_Configuration_Schema" + } + }, + "resourceElementTemplates": [ + { + "name": "MyVM", + "type": "ArmResourceDefinition", + "dependsOnProfile": { + "installDependsOn": [] + }, + "configuration": { + "templateType": "ArmTemplate", + "parameterValues": "\"publisherName\": \"{configurationparameters('MyVM_Configuration').publisherName}\",\r\n \"skuGroupName\": \"{configurationparameters('MyVM_Configuration').skuGroupName}\",\r\n \"skuVersion\": \"{configurationparameters('MyVM_Configuration').skuVersion}\",\r\n \"skuOfferingLocation\": \"{configurationparameters('MyVM_Configuration').skuOfferingLocation}\",\r\n \"nfviType\": \"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviType}\",\r\n \"nfviId\": \"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviId}\",\r\n \"allowSoftwareUpdates\": \"{configurationparameters('MyVM_Configuration').allowSoftwareUpdates}\",\r\n \"virtualNetworkName\": \"{configurationparameters('MyVM_Configuration').vnetName}\",\r\n \"subnetName\": \"{configurationparameters('MyVM_Configuration').subnetName}\",\r\n \"subnetAddressPrefix\": \"{configurationparameters('MyVM_Configuration').subnetAddressPrefix}\",\r\n \"managedResourceGroup\": \"{configurationparameters('SNSSelf').managedResourceGroupName}\"\r\n ", + "artifactProfile": { + "artifactStoreReference": { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/publishers/contosoGroup/ArtifactStore/store1" + }, + "artifactName": "MyVMArmTemplate", + "artifactVersion": "1.0.0" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherCreate.json new file mode 100644 index 000000000000..819e8a81f95c --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "parameters": { + "location": "eastus", + "properties": { + "scope": "Public" + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestPublisher", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher", + "type": "Microsoft.HybridNetwork/publishers", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "scope": "Public" + } + } + }, + "201": { + "body": { + "name": "TestPublisher", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher", + "type": "Microsoft.HybridNetwork/publishers", + "location": "eastus", + "properties": { + "provisioningState": "Accepted", + "scope": "Public" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherDelete.json new file mode 100644 index 000000000000..9431d8353aea --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherGet.json new file mode 100644 index 000000000000..2e796df4e3f6 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher" + }, + "responses": { + "200": { + "body": { + "name": "TestPublisher", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher", + "type": "Microsoft.HybridNetwork/publishers", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "scope": "Public" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherListByResourceGroup.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherListByResourceGroup.json new file mode 100644 index 000000000000..8b41ed7abdc3 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherListByResourceGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestPublisher", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher", + "type": "Microsoft.HybridNetwork/publishers", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "scope": "Public" + } + }, + { + "name": "TestPublisher2", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher2", + "type": "Microsoft.HybridNetwork/publishers", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "scope": "Public" + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherListBySubscription.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherListBySubscription.json new file mode 100644 index 000000000000..98dac107ea18 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherListBySubscription.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestPublisher", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher", + "type": "Microsoft.HybridNetwork/publishers", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "scope": "Public" + } + }, + { + "name": "TestPublisher2", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher2", + "type": "Microsoft.HybridNetwork/publishers", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "scope": "Public" + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherUpdateTags.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherUpdateTags.json new file mode 100644 index 000000000000..9f3696fe0d5c --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "publisherName": "TestPublisher", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestPublisher", + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher", + "type": "Microsoft.HybridNetwork/publishers", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "scope": "Public" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PureProxyArtifact/ArtifactChangeState.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PureProxyArtifact/ArtifactChangeState.json new file mode 100644 index 000000000000..c747c1af348c --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PureProxyArtifact/ArtifactChangeState.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "TestResourceGroup", + "publisherName": "TestPublisher", + "artifactStoreName": "TestArtifactStoreName", + "artifactName": "fedrbac", + "artifactVersionName": "1.0.0", + "parameters": { + "properties": { + "artifactState": "Deprecated" + } + } + }, + "responses": { + "200": { + "body": { + "name": "fedrbac", + "id": "/subscriptions/subid/resourceGroups/TestResourceGroup/providers/Microsoft.HybridNetwork/publishers/TestPublisher/artifactStores/TestArtifactStore/artifactVersions/1.0.0", + "type": "Microsoft.HybridNetwork/publishers/artifactStores/artifactVersions", + "properties": { + "artifactVersion": "1.0.0", + "artifactType": "OCIArtifact", + "artifactState": "Deprecated" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PureProxyArtifact/ArtifactGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PureProxyArtifact/ArtifactGet.json new file mode 100644 index 000000000000..a54ed5c3116b --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PureProxyArtifact/ArtifactGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "TestResourceGroup", + "publisherName": "TestPublisher", + "artifactStoreName": "TestArtifactStoreName", + "artifactName": "fedrbac" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "fedrbac", + "id": "/subscriptions/subid/resourceGroups/TestResourceGroup/providers/Microsoft.HybridNetwork/publishers/TestPublisher/artifactStores/TestArtifactStore/artifactVersions", + "type": "Microsoft.HybridNetwork/publishers/artifactStores/artifactVersions", + "properties": { + "artifactVersion": "1.0.0", + "artifactType": "OCIArtifact", + "artifactState": "Deprecated" + } + }, + { + "name": "fedrbac", + "id": "/subscriptions/subid/resourceGroups/TestResourceGroup/providers/Microsoft.HybridNetwork/publishers/TestPublisher/artifactStores/TestArtifactStore/artifactVersions", + "type": "Microsoft.HybridNetwork/publishers/artifactStores/artifactVersions", + "properties": { + "artifactVersion": "2.0.0", + "artifactType": "OCIArtifact", + "artifactState": "Active" + } + } + ], + "nextLink": "{refererHeaderUrl}?$skipToken={opaqueString}" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PureProxyArtifact/ArtifactList.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PureProxyArtifact/ArtifactList.json new file mode 100644 index 000000000000..eab3ed163f55 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PureProxyArtifact/ArtifactList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "TestResourceGroup", + "publisherName": "TestPublisher", + "artifactStoreName": "TestArtifactStoreName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "fedrbac1", + "id": "/subscriptions/subid/resourceGroups/TestResourceGroup/providers/Microsoft.HybridNetwork/publishers/TestPublisher/artifactStores/TestArtifactStore/artifactVersions", + "type": "Microsoft.HybridNetwork/publishers/artifactStores/artifactVersions" + }, + { + "name": "fedrbac2", + "id": "/subscriptions/subid/resourceGroups/TestResourceGroup/providers/Microsoft.HybridNetwork/publishers/TestPublisher/artifactStores/TestArtifactStore/artifactVersions", + "type": "Microsoft.HybridNetwork/publishers/artifactStores/artifactVersions" + } + ], + "nextLink": "{refererHeaderUrl}?$skipToken={opaqueString}" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteCreate.json new file mode 100644 index 000000000000..d3294c424b63 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteCreate.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "siteName": "testSite", + "parameters": { + "location": "westUs2", + "properties": { + "nfvis": [ + { + "nfviType": "AzureCore", + "name": "nfvi1", + "location": "westUs2" + }, + { + "name": "nfvi2", + "nfviType": "AzureArcKubernetes", + "customLocationReference": { + "id": "/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation1" + } + }, + { + "name": "nfvi3", + "nfviType": "AzureOperatorNexus", + "customLocationReference": { + "id": "/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation2" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testSite", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/sites/testSite", + "type": "Microsoft.HybridNetwork/sites", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "properties": { + "provisioningState": "Accepted", + "nfvis": [ + { + "nfviType": "AzureCore", + "name": "nfvi1", + "location": "westUs2" + }, + { + "name": "nfvi2", + "nfviType": "AzureArcKubernetes", + "customLocationReference": { + "id": "/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation1" + } + }, + { + "name": "nfvi3", + "nfviType": "AzureOperatorNexus", + "customLocationReference": { + "id": "/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation2" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "testSite", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/sites/testSite", + "type": "Microsoft.HybridNetwork/sites", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "properties": { + "provisioningState": "Accepted", + "nfvis": [ + { + "nfviType": "AzureCore", + "name": "nfvi1", + "location": "westUs2" + }, + { + "name": "nfvi2", + "nfviType": "AzureArcKubernetes", + "customLocationReference": { + "id": "/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation1" + } + }, + { + "name": "nfvi3", + "nfviType": "AzureOperatorNexus", + "customLocationReference": { + "id": "/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation2" + } + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteDelete.json new file mode 100644 index 000000000000..9eeaf33fc21d --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "siteName": "testSite" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteGet.json new file mode 100644 index 000000000000..0c3e4d562598 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "siteName": "testSite" + }, + "responses": { + "200": { + "body": { + "name": "testSite", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/sites/testSite", + "type": "Microsoft.HybridNetwork/sites", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "properties": { + "provisioningState": "Accepted", + "nfvis": [ + { + "nfviType": "AzureCore", + "name": "nfvi1", + "location": "westUs2" + }, + { + "name": "nfvi2", + "nfviType": "AzureArcKubernetes", + "customLocationReference": { + "id": "/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation1" + } + }, + { + "name": "nfvi3", + "nfviType": "AzureOperatorNexus", + "customLocationReference": { + "id": "/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation2" + } + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteListByResourceGroup.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteListByResourceGroup.json new file mode 100644 index 000000000000..a09dbf5bf819 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testSite", + "id": "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/sites/testSite", + "type": "Microsoft.HybridNetwork/orchestrators/sites", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "properties": { + "nfvis": [ + { + "nfviType": "AzureCore", + "name": "azureWestUs2", + "location": "westUs2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteListBySubscription.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteListBySubscription.json new file mode 100644 index 000000000000..34323bcd78e3 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteListBySubscription.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testSite", + "id": "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/sites/testSite", + "type": "Microsoft.HybridNetwork/sites", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "properties": { + "provisioningState": "Accepted", + "nfvis": [ + { + "nfviType": "AzureCore", + "name": "azureWestUs2", + "location": "westUs2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceCreate.json new file mode 100644 index 000000000000..41cee04bd863 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceCreate.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "siteNetworkServiceName": "testSiteNetworkServiceName", + "parameters": { + "location": "westUs2", + "sku": { + "name": "Standard" + }, + "properties": { + "siteReference": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite" + }, + "networkServiceDesignVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0", + "idType": "Open" + }, + "desiredStateConfigurationGroupValueReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "testSiteNetworkServiceName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName", + "type": "Microsoft.HybridNetwork/siteNetworkServices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Accepted", + "siteReference": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite" + }, + "publisherName": "testPublisher", + "publisherScope": "Public", + "networkServiceDesignGroupName": "testNetworkServiceDesignGroupName", + "networkServiceDesignVersionName": "1.0.1", + "networkServiceDesignVersionOfferingLocation": "eastus", + "networkServiceDesignVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testPublisher/networkServiceDesignGroups/testNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.1", + "idType": "Open" + }, + "desiredStateConfigurationGroupValueReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1" + } + } + } + } + }, + "201": { + "body": { + "name": "testSiteNetworkServiceName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName", + "type": "Microsoft.HybridNetwork/siteNetworkServices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Accepted", + "siteReference": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite" + }, + "publisherName": "testPublisher", + "publisherScope": "Public", + "networkServiceDesignGroupName": "testNetworkServiceDesignGroupName", + "networkServiceDesignVersionName": "1.0.1", + "networkServiceDesignVersionOfferingLocation": "eastus", + "networkServiceDesignVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testPublisher/networkServiceDesignGroups/testNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.1", + "idType": "Open" + }, + "desiredStateConfigurationGroupValueReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1" + } + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceDelete.json new file mode 100644 index 000000000000..c3dc20095cbd --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "siteNetworkServiceName": "testSiteNetworkServiceName" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.hybridnetwork/locations/EASTUS2EUAP/operationStatuses/0b37c625-7e7c-49c5-b86e-c817c85acb5d*B77A34159CA34A0BD446D3BC7EC120649181590DDF991982765DAC1A87491B2D?api-version=2021-05-01" + } + }, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceFirstPartyCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceFirstPartyCreate.json new file mode 100644 index 000000000000..9f4dcdb18554 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceFirstPartyCreate.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "siteNetworkServiceName": "testSiteNetworkServiceName", + "parameters": { + "location": "westUs2", + "sku": { + "name": "Standard" + }, + "properties": { + "siteReference": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite" + }, + "networkServiceDesignVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0", + "idType": "Secret" + }, + "desiredStateConfigurationGroupValueReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "testSiteNetworkServiceName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName", + "type": "Microsoft.HybridNetwork/siteNetworkServices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Accepted", + "siteReference": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite" + }, + "publisherName": "testPublisher", + "publisherScope": "Public", + "networkServiceDesignGroupName": "testNetworkServiceDesignGroupName", + "networkServiceDesignVersionName": "1.0.1", + "networkServiceDesignVersionOfferingLocation": "eastus", + "networkServiceDesignVersionResourceReference": { + "idType": "Secret" + }, + "desiredStateConfigurationGroupValueReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1" + } + } + } + } + }, + "201": { + "body": { + "name": "testSiteNetworkServiceName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName", + "type": "Microsoft.HybridNetwork/siteNetworkServices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Accepted", + "siteReference": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite" + }, + "publisherName": "testPublisher", + "publisherScope": "Public", + "networkServiceDesignGroupName": "testNetworkServiceDesignGroupName", + "networkServiceDesignVersionName": "1.0.1", + "networkServiceDesignVersionOfferingLocation": "eastus", + "networkServiceDesignVersionResourceReference": { + "idType": "Secret" + }, + "desiredStateConfigurationGroupValueReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1" + } + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceGet.json new file mode 100644 index 000000000000..3ff0d47805a6 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "siteNetworkServiceName": "testSiteNetworkServiceName" + }, + "responses": { + "200": { + "body": { + "name": "testSiteNetworkServiceName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName", + "type": "Microsoft.HybridNetwork/siteNetworkServices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Accepted", + "siteReference": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite" + }, + "publisherName": "testPublisher", + "publisherScope": "Public", + "networkServiceDesignGroupName": "testNetworkServiceDesignGroupName", + "networkServiceDesignVersionName": "1.0.1", + "networkServiceDesignVersionOfferingLocation": "eastus", + "networkServiceDesignVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testPublisher/networkServiceDesignGroups/testNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.1", + "idType": "Open" + }, + "desiredStateConfigurationGroupValueReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1" + } + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceListByResourceGroup.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceListByResourceGroup.json new file mode 100644 index 000000000000..75c624df5d28 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testSiteNetworkServiceName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName", + "type": "Microsoft.HybridNetwork/siteNetworkServices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Accepted", + "siteReference": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite" + }, + "publisherName": "testPublisher", + "publisherScope": "Public", + "networkServiceDesignGroupName": "testNetworkServiceDesignGroupName", + "networkServiceDesignVersionName": "1.0.1", + "networkServiceDesignVersionOfferingLocation": "eastus", + "networkServiceDesignVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testPublisher/networkServiceDesignGroups/testNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.1", + "idType": "Open" + }, + "desiredStateConfigurationGroupValueReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1" + } + } + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceListBySubscription.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceListBySubscription.json new file mode 100644 index 000000000000..57564f490bf9 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceListBySubscription.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testSiteNetworkServiceName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName", + "type": "Microsoft.HybridNetwork/siteNetworkServices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Accepted", + "siteReference": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite" + }, + "publisherName": "testPublisher", + "publisherScope": "Public", + "networkServiceDesignGroupName": "testNetworkServiceDesignGroupName", + "networkServiceDesignVersionName": "1.0.1", + "networkServiceDesignVersionOfferingLocation": "eastus", + "networkServiceDesignVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testPublisher/networkServiceDesignGroups/testNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.1", + "idType": "Open" + }, + "desiredStateConfigurationGroupValueReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1" + } + } + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceUpdateTags.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceUpdateTags.json new file mode 100644 index 000000000000..d495efa4aa28 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceUpdateTags.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "siteName": "testSite", + "siteNetworkServiceName": "testSiteNetworkServiceName", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testSiteNetworkServiceName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName", + "type": "Microsoft.HybridNetwork/siteNetworkServices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Accepted", + "siteReference": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite" + }, + "publisherName": "testPublisher", + "publisherScope": "Public", + "networkServiceDesignGroupName": "testNetworkServiceDesignGroupName", + "networkServiceDesignVersionName": "1.0.1", + "networkServiceDesignVersionOfferingLocation": "eastus", + "networkServiceDesignVersionResourceReference": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testPublisher/networkServiceDesignGroups/testNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.1", + "idType": "Open" + }, + "desiredStateConfigurationGroupValueReferences": { + "MyVM_Configuration": { + "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1" + } + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteUpdateTags.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteUpdateTags.json new file mode 100644 index 000000000000..cd35cd40d70c --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteUpdateTags.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "siteName": "testSite", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testSite", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/sites/testSite", + "type": "Microsoft.HybridNetwork/sites", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "westUs2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Accepted", + "nfvis": [ + { + "nfviType": "AzureCore", + "name": "azureWestUs2", + "location": "westUs2" + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/networkFunction.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/networkFunction.json new file mode 100644 index 000000000000..304bd7468b24 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/networkFunction.json @@ -0,0 +1,1118 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage the network function deployment in a Hybrid Network resource provider.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/networkFunctions/{networkFunctionName}": { + "delete": { + "tags": [ + "NetworkFunctions" + ], + "operationId": "NetworkFunctions_Delete", + "description": "Deletes the specified network function resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed successfully." + }, + "202": { + "description": "Accepted. The header contains 'Azure-AsyncOperation' header pointing to an operations resource. The operation URI can be queried to find the current state of the operation.", + "headers": { + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "204": { + "description": "Request is successful. Resource with the specified name does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete network function resource": { + "$ref": "./examples/NetworkFunctionDelete.json" + }, + "Delete virtual network function resource on AzureOperatorNexus": { + "$ref": "./examples/AzureOperatorNexus/VirtualNetworkFunctionDelete.json" + }, + "Delete virtual network function resource on AzureCore": { + "$ref": "./examples/AzureCore/VirtualNetworkFunctionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "NetworkFunctions" + ], + "operationId": "NetworkFunctions_Get", + "description": "Gets information about the specified network function resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFunctionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network function resource." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation is successful. The operation returns the resulting network function resource.", + "schema": { + "$ref": "#/definitions/NetworkFunction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network function resource": { + "$ref": "./examples/NetworkFunctionGet.json" + }, + "Get virtual network function resource on AzureOperatorNexus": { + "$ref": "./examples/AzureOperatorNexus/VirtualNetworkFunctionGet.json" + }, + "Get virtual network function resource on AzureCore": { + "$ref": "./examples/AzureCore/VirtualNetworkFunctionGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkFunctions" + ], + "operationId": "NetworkFunctions_CreateOrUpdate", + "description": "Creates or updates a network function resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFunctionName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource name for the network function resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFunction" + }, + "description": "Parameters supplied in the body to the create or update network function operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Create or update operation has been completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFunction" + } + }, + "201": { + "description": "Create or update operation has been completed successfully. The header contains 'Azure-AsyncOperation' header pointing to an operation resource. The operation URI can be queried to find the current state of the operation.", + "schema": { + "$ref": "#/definitions/NetworkFunction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create network function resource": { + "$ref": "./examples/NetworkFunctionCreate.json" + }, + "Create network function resource with secrets": { + "$ref": "./examples/NetworkFunctionCreateSecret.json" + }, + "Create first party network function resource": { + "$ref": "./examples/NetworkFunctionFirstPartyCreate.json" + }, + "Create virtual network function resource on AzureOperatorNexus": { + "$ref": "./examples/AzureOperatorNexus/VirtualNetworkFunctionCreate.json" + }, + "Create virtual network function resource on AzureCore": { + "$ref": "./examples/AzureCore/VirtualNetworkFunctionCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "NetworkFunctions" + ], + "operationId": "NetworkFunctions_UpdateTags", + "description": "Updates the tags for the network function resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFunctionName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource name for the network function resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the update network function tags operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update is completed successfully. The operation returns the resulting network function resource.", + "schema": { + "$ref": "#/definitions/NetworkFunction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update tags for network function resource": { + "$ref": "./examples/NetworkFunctionUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/networkFunctions": { + "get": { + "description": "Lists all the network functions in a subscription.", + "operationId": "NetworkFunctions_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of network function resources.", + "schema": { + "$ref": "#/definitions/NetworkFunctionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "NetworkFunctions" + ], + "x-ms-examples": { + "List all network function resources in subscription.": { + "$ref": "./examples/NetworkFunctionListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/networkFunctions": { + "get": { + "tags": [ + "NetworkFunctions" + ], + "operationId": "NetworkFunctions_ListByResourceGroup", + "description": "Lists all the network function resources in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of network function resources.", + "schema": { + "$ref": "#/definitions/NetworkFunctionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List network function in resource group": { + "$ref": "./examples/NetworkFunctionListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/networkFunctions/{networkFunctionName}/executeRequest": { + "post": { + "tags": [ + "NetworkFunctions" + ], + "operationId": "NetworkFunctions_ExecuteRequest", + "description": "Execute a request to services on a containerized network function.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExecuteRequestParameters" + }, + "description": "Payload for execute request post call." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted. The header contains 'Azure-AsyncOperation' header which can be used to monitor the progress of the operation.", + "headers": { + "Location": { + "description": "The Location 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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Send request to network function services": { + "$ref": "./examples/NetworkFunctionsExecuteRequest.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/networkFunctions/{networkFunctionName}/components/{componentName}": { + "get": { + "tags": [ + "Components" + ], + "operationId": "Components_Get", + "description": "Gets information about the specified application instance resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionComponentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation is successful. The operation returns the resulting component resource.", + "schema": { + "$ref": "#/definitions/Component" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get component resource": { + "$ref": "./examples/ComponentGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/networkFunctions/{networkFunctionName}/components": { + "get": { + "tags": [ + "Components" + ], + "operationId": "Components_ListByNetworkFunction", + "description": "Lists all the component resources in a network function.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionNameParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of component resources.", + "schema": { + "$ref": "#/definitions/ComponentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List components in network function": { + "$ref": "./examples/ComponentListByNetworkFunction.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "NetworkFunction": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/NetworkFunctionPropertiesFormat", + "description": "Network function properties." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed identity of the network function." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Network function resource response." + }, + "NetworkFunctionPropertiesFormat": { + "type": "object", + "description": "Network function properties.", + "required": [ + "configurationType" + ], + "discriminator": "configurationType", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network function resource." + }, + "publisherName": { + "readOnly": true, + "type": "string", + "description": "The publisher name for the network function." + }, + "publisherScope": { + "readOnly": true, + "$ref": "./common.json#/definitions/PublisherScope", + "description": "The scope of the publisher." + }, + "networkFunctionDefinitionGroupName": { + "readOnly": true, + "type": "string", + "description": "The network function definition group name for the network function." + }, + "networkFunctionDefinitionVersion": { + "readOnly": true, + "type": "string", + "description": "The network function definition version for the network function." + }, + "networkFunctionDefinitionOfferingLocation": { + "readOnly": true, + "type": "string", + "description": "The location of the network function definition offering." + }, + "networkFunctionDefinitionVersionResourceReference": { + "$ref": "./common.json#/definitions/DeploymentResourceIdReference", + "description": "The network function definition version resource reference." + }, + "nfviType": { + "$ref": "./common.json#/definitions/NFVIType", + "description": "The nfvi type for the network function." + }, + "nfviId": { + "type": "string", + "description": "The nfviId for the network function." + }, + "allowSoftwareUpdate": { + "type": "boolean", + "description": "Indicates if software updates are allowed during deployment." + }, + "configurationType": { + "$ref": "#/definitions/NetworkFunctionConfigurationType", + "description": "The value which indicates if NF values are secrets" + }, + "roleOverrideValues": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleOverrideValues" + }, + "description": "The role configuration override values from the user." + } + } + }, + "NetworkFunctionValueWithSecrets": { + "description": "NetworkFunction with secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkFunctionPropertiesFormat" + } + ], + "properties": { + "secretDeploymentValues": { + "type": "string", + "description": "The JSON-serialized secret deployment values from the user. This contains secrets like passwords,keys etc", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + } + }, + "x-ms-discriminator-value": "Secret" + }, + "NetworkFunctionValueWithoutSecrets": { + "description": "NetworkFunction with no secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkFunctionPropertiesFormat" + } + ], + "properties": { + "deploymentValues": { + "type": "string", + "description": "The JSON-serialized deployment values from the user." + } + }, + "x-ms-discriminator-value": "Open" + }, + "NetworkFunctionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkFunction" + }, + "description": "A list of network function resources in a subscription or resource group." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for network function API service call." + }, + "NetworkFunctionConfigurationType": { + "type": "string", + "description": "The secret type which indicates if secret or not.", + "enum": [ + "Unknown", + "Secret", + "Open" + ], + "x-ms-enum": { + "name": "NetworkFunctionConfigurationType", + "modelAsString": true + } + }, + "RoleOverrideValues": { + "type": "string", + "description": "The JSON-serialized role configuration override values." + }, + "Component": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/ComponentProperties", + "description": "The component properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "description": "The component sub resource." + }, + "ComponentProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the component resource." + }, + "deploymentProfile": { + "readOnly": true, + "type": "string", + "description": "The JSON-serialized deployment profile of the component resource." + }, + "deploymentStatus": { + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "$ref": "#/definitions/DeploymentStatusProperties", + "description": "The deployment status of the component resource." + } + }, + "description": "The component properties of the network function." + }, + "DeploymentStatusProperties": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the component resource." + }, + "resources": { + "$ref": "#/definitions/Resources", + "description": "The resource related to the component resource." + }, + "nextExpectedUpdateAt": { + "type": "string", + "format": "date-time", + "description": "The next expected update of deployment status." + } + }, + "description": "The deployment status properties of the network function component." + }, + "Status": { + "type": "string", + "description": "The component resource deployment status.", + "enum": [ + "Unknown", + "Deployed", + "Uninstalled", + "Superseded", + "Failed", + "Uninstalling", + "Pending-Install", + "Pending-Upgrade", + "Pending-Rollback", + "Downloading", + "Installing", + "Reinstalling", + "Rollingback", + "Upgrading" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "Resources": { + "type": "object", + "properties": { + "deployments": { + "type": "array", + "items": { + "$ref": "#/definitions/Deployment" + }, + "description": "Deployments that are related to component resource.", + "x-ms-identifiers": [] + }, + "pods": { + "type": "array", + "items": { + "$ref": "#/definitions/Pod" + }, + "description": "Pods related to component resource.", + "x-ms-identifiers": [] + }, + "replicaSets": { + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaSet" + }, + "description": "Replica sets related to component resource.", + "x-ms-identifiers": [] + }, + "statefulSets": { + "type": "array", + "items": { + "$ref": "#/definitions/StatefulSet" + }, + "description": "Stateful sets related to component resource.", + "x-ms-identifiers": [] + }, + "daemonSets": { + "type": "array", + "items": { + "$ref": "#/definitions/DaemonSet" + }, + "description": "Daemonsets related to component resource.", + "x-ms-identifiers": [] + } + }, + "description": "The resources of the network function component." + }, + "Deployment": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the deployment." + }, + "namespace": { + "type": "string", + "description": "The namespace of the deployment." + }, + "desired": { + "type": "integer", + "format": "int32", + "description": "Desired number of pods" + }, + "ready": { + "type": "integer", + "format": "int32", + "description": "Number of ready pods." + }, + "upToDate": { + "type": "integer", + "format": "int32", + "description": "Number of upto date pods." + }, + "available": { + "type": "integer", + "format": "int32", + "description": "Number of available pods." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Creation Time of deployment." + } + }, + "description": "Helm Deployment status properties." + }, + "Pod": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Pod." + }, + "namespace": { + "type": "string", + "description": "The namespace of the Pod." + }, + "desired": { + "type": "integer", + "format": "int32", + "description": "Desired number of containers" + }, + "ready": { + "type": "integer", + "format": "int32", + "description": "Number of ready containers." + }, + "status": { + "$ref": "#/definitions/PodStatus", + "description": "The status of a pod." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Creation Time of Pod." + }, + "events": { + "type": "array", + "items": { + "$ref": "#/definitions/PodEvent" + }, + "description": "Last 5 Pod events.", + "x-ms-identifiers": [] + } + }, + "description": "Helm Pod status properties." + }, + "PodStatus": { + "type": "string", + "description": "The status of a Pod.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Running", + "Pending", + "Terminating", + "NotReady" + ], + "x-ms-enum": { + "name": "PodStatus", + "modelAsString": true + } + }, + "PodEvent": { + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/PodEventType", + "description": "The type of pod event." + }, + "reason": { + "type": "string", + "description": "Event reason." + }, + "message": { + "type": "string", + "description": "Event message." + }, + "lastSeenTime": { + "type": "string", + "format": "date-time", + "description": "Event Last seen." + } + }, + "description": "Pod Event properties." + }, + "PodEventType": { + "type": "string", + "description": "The type of pod event.", + "enum": [ + "Normal", + "Warning" + ], + "x-ms-enum": { + "name": "PodEventType", + "modelAsString": true + } + }, + "ReplicaSet": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the replicaSet." + }, + "namespace": { + "type": "string", + "description": "The namespace of the replicaSet." + }, + "desired": { + "type": "integer", + "format": "int32", + "description": "Desired number of pods" + }, + "ready": { + "type": "integer", + "format": "int32", + "description": "Number of ready pods." + }, + "current": { + "type": "integer", + "format": "int32", + "description": "Number of current pods." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Creation Time of replicaSet." + } + }, + "description": "Helm ReplicaSet status properties." + }, + "StatefulSet": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the statefulset." + }, + "namespace": { + "type": "string", + "description": "The namespace of the statefulset." + }, + "desired": { + "type": "integer", + "format": "int32", + "description": "Desired number of pods" + }, + "ready": { + "type": "integer", + "format": "int32", + "description": "Number of ready pods." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Creation Time of statefulset." + } + }, + "description": "Helm StatefulSet status properties." + }, + "DaemonSet": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the daemonSet." + }, + "namespace": { + "type": "string", + "description": "The namespace of the daemonSet." + }, + "desired": { + "type": "integer", + "format": "int32", + "description": "Desired number of pods" + }, + "current": { + "type": "integer", + "format": "int32", + "description": "Current number of pods" + }, + "ready": { + "type": "integer", + "format": "int32", + "description": "Number of Ready pods" + }, + "upToDate": { + "type": "integer", + "format": "int32", + "description": "Number of upto date pods" + }, + "available": { + "type": "integer", + "format": "int32", + "description": "Number of available pods." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Creation Time of daemonSet." + } + }, + "description": "Helm DaemonSet status properties." + }, + "ComponentListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Component" + }, + "description": "A list of component resources in a networkFunction." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list component API service call." + }, + "ExecuteRequestParameters": { + "type": "object", + "properties": { + "serviceEndpoint": { + "type": "string", + "description": "The endpoint of service to call." + }, + "requestMetadata": { + "$ref": "#/definitions/RequestMetadata", + "description": "The request metadata." + } + }, + "required": [ + "serviceEndpoint", + "requestMetadata" + ], + "description": "Payload for execute request post call." + }, + "RequestMetadata": { + "type": "object", + "properties": { + "relativePath": { + "type": "string", + "description": "The relative path of the request." + }, + "httpMethod": { + "type": "string", + "description": "The http method of the request.", + "enum": [ + "Unknown", + "Post", + "Put", + "Get", + "Patch", + "Delete" + ], + "x-ms-enum": { + "name": "HttpMethod", + "modelAsString": true + } + }, + "serializedBody": { + "type": "string", + "description": "The serialized body of the request." + }, + "apiVersion": { + "type": "string", + "description": "The api version of the request." + } + }, + "required": [ + "relativePath", + "httpMethod", + "serializedBody" + ], + "description": "Request metadata of execute request post call payload." + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/networkFunctionDefinition.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/networkFunctionDefinition.json new file mode 100644 index 000000000000..fd9068515423 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/networkFunctionDefinition.json @@ -0,0 +1,1472 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used by publishers to on-board offerings and manage network functions.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/networkFunctionDefinitionGroups": { + "get": { + "tags": [ + "NetworkFunctionDefinitionGroups" + ], + "operationId": "NetworkFunctionDefinitionGroups_ListByPublisher", + "description": "Gets information of the network function definition groups under a publisher.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting networkFunctionDefinition group resource.", + "schema": { + "$ref": "#/definitions/NetworkFunctionDefinitionGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get networkFunctionDefinition groups under publisher resource": { + "$ref": "./examples/NetworkFunctionDefinitionGroupsListByPublisherName.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/networkFunctionDefinitionGroups/{networkFunctionDefinitionGroupName}": { + "delete": { + "tags": [ + "NetworkFunctionDefinitionGroups" + ], + "operationId": "NetworkFunctionDefinitionGroups_Delete", + "description": "Deletes a specified network function definition group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. Sets provisioningState to 'Deleting' until the operation is completed. Returns an operation URI that can be queried to find the current state of the operation.", + "headers": { + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "204": { + "description": "Request is successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a network function group resource": { + "$ref": "./examples/NetworkFunctionDefinitionGroupDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "put": { + "tags": [ + "NetworkFunctionDefinitionGroups" + ], + "operationId": "NetworkFunctionDefinitionGroups_CreateOrUpdate", + "description": "Creates or updates a network function definition group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFunctionDefinitionGroup" + }, + "description": "Parameters supplied to the create or update publisher network function definition group operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting NetworkFunctionDefinitionGroup sub resource.", + "schema": { + "$ref": "#/definitions/NetworkFunctionDefinitionGroup" + } + }, + "201": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting NetworkFunctionDefinitionGroup sub resource.", + "schema": { + "$ref": "#/definitions/NetworkFunctionDefinitionGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update the network function definition group": { + "$ref": "./examples/NetworkFunctionDefinitionGroupCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "NetworkFunctionDefinitionGroups" + ], + "operationId": "NetworkFunctionDefinitionGroups_Get", + "description": "Gets information about the specified networkFunctionDefinition group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting publisher network function definition group resource.", + "schema": { + "$ref": "#/definitions/NetworkFunctionDefinitionGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a networkFunctionDefinition group resource": { + "$ref": "./examples/NetworkFunctionDefinitionGroupGet.json" + } + } + }, + "patch": { + "tags": [ + "NetworkFunctionDefinitionGroups" + ], + "operationId": "NetworkFunctionDefinitionGroups_Update", + "description": "Updates a network function definition group resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the create or update publisher network function definition group operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Creation or update is successful. The operation returns the resulting network function definition group resource.", + "schema": { + "$ref": "#/definitions/NetworkFunctionDefinitionGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update the network function definition group resource": { + "$ref": "./examples/NetworkFunctionDefinitionGroupUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/networkFunctionDefinitionGroups/{networkFunctionDefinitionGroupName}/networkFunctionDefinitionVersions/{networkFunctionDefinitionVersionName}": { + "delete": { + "tags": [ + "NetworkFunctionDefinitionVersions" + ], + "operationId": "NetworkFunctionDefinitionVersions_Delete", + "description": "Deletes the specified network function definition version.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionVersionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. Sets provisioningState to 'Deleting' until the operation is completed. Returns an operation URI that can be queried to find the current state of the operation.", + "headers": { + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "204": { + "description": "Request is successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a network function definition version": { + "$ref": "./examples/NetworkFunctionDefinitionVersionDelete.json" + }, + "Delete a network function definition version for AzureOperatorNexus VNF": { + "$ref": "./examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionDelete.json" + }, + "Delete a network function definition version for AzureCore VNF": { + "$ref": "./examples/AzureCore/VirtualNetworkFunctionDefinitionVersionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "put": { + "tags": [ + "NetworkFunctionDefinitionVersions" + ], + "operationId": "NetworkFunctionDefinitionVersions_CreateOrUpdate", + "description": "Creates or updates a network function definition version.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionVersionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFunctionDefinitionVersion" + }, + "description": "Parameters supplied to the create or update network function definition version operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting network function definition sub resource.", + "schema": { + "$ref": "#/definitions/NetworkFunctionDefinitionVersion" + } + }, + "201": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting network function definition sub resource.", + "schema": { + "$ref": "#/definitions/NetworkFunctionDefinitionVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a network function definition version resource": { + "$ref": "./examples/NetworkFunctionDefinitionVersionCreate.json" + }, + "Create or update a network function definition version resource for AzureOperatorNexus VNF": { + "$ref": "./examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionCreate.json" + }, + "Create or update a network function definition version resource for AzureCore VNF": { + "$ref": "./examples/AzureCore/VirtualNetworkFunctionDefinitionVersionCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "NetworkFunctionDefinitionVersions" + ], + "operationId": "NetworkFunctionDefinitionVersions_Get", + "description": "Gets information about a network function definition version.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionVersionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting NetworkFunctionDefinitionVersion resource.", + "schema": { + "$ref": "#/definitions/NetworkFunctionDefinitionVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a network function definition version resource": { + "$ref": "./examples/NetworkFunctionDefinitionVersionGet.json" + }, + "Get network function definition version resource for AzureOperatorNexus VNF": { + "$ref": "./examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionGet.json" + }, + "Get network function definition version resource for AzureCore VNF": { + "$ref": "./examples/AzureCore/VirtualNetworkFunctionDefinitionVersionGet.json" + } + } + }, + "patch": { + "tags": [ + "NetworkFunctionDefinitionVersions" + ], + "operationId": "NetworkFunctionDefinitionVersions_Update", + "description": "Updates a network function definition version resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionVersionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the create or update network function definition version operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Creation or update is successful. The operation returns the resulting network function definition sub resource.", + "schema": { + "$ref": "#/definitions/NetworkFunctionDefinitionVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update the network function definition version tags": { + "$ref": "./examples/NetworkFunctionDefinitionVersionUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/networkFunctionDefinitionGroups/{networkFunctionDefinitionGroupName}/networkFunctionDefinitionVersions": { + "get": { + "tags": [ + "NetworkFunctionDefinitionVersions" + ], + "operationId": "NetworkFunctionDefinitionVersions_ListByNetworkFunctionDefinitionGroup", + "description": "Gets information about a list of network function definition versions under a network function definition group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting NetworkFunctionDefinitionVersion resource.", + "schema": { + "$ref": "#/definitions/NetworkFunctionDefinitionVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Publisher resource": { + "$ref": "./examples/NetworkFunctionDefinitionVersionListByNetworkFunctionDefinitionGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/networkFunctionDefinitionGroups/{networkFunctionDefinitionGroupName}/networkFunctionDefinitionVersions/{networkFunctionDefinitionVersionName}/updateState": { + "post": { + "tags": [ + "NetworkFunctionDefinitionVersions" + ], + "operationId": "NetworkFunctionDefinitionVersions_updateState", + "description": "Update network function definition version state.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkFunctionDefinitionVersionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFunctionDefinitionVersionUpdateState" + }, + "description": "Parameters supplied to update the state of network function definition version." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The updated network function definition version state.", + "schema": { + "$ref": "#/definitions/NetworkFunctionDefinitionVersionUpdateState" + } + }, + "202": { + "description": "The request of updating network function definition version state is accepted.", + "headers": { + "Location": { + "description": "The Location 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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update network function definition version state": { + "$ref": "./examples/NetworkFunctionDefinitionVersionUpdateState.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "NetworkFunctionDefinitionGroup": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/NetworkFunctionDefinitionGroupPropertiesFormat", + "description": "Network function definition group properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Network function definition group resource." + }, + "NetworkFunctionDefinitionGroupPropertiesFormat": { + "description": "Network function definition group properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network function definition groups resource." + }, + "description": { + "type": "string", + "description": "The network function definition group description." + } + } + }, + "NetworkFunctionDefinitionGroupListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkFunctionDefinitionGroup" + }, + "description": "A list of network function definition group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of network function definition group resources." + }, + "NetworkFunctionDefinitionVersionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkFunctionDefinitionVersion" + }, + "description": "A list of network function definition versions." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to get the next set of results." + } + }, + "description": "A list of network function definition versions." + }, + "NetworkFunctionDefinitionVersion": { + "description": "Network function definition version.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/NetworkFunctionDefinitionVersionPropertiesFormat", + "description": "Network function definition version properties." + } + } + }, + "NetworkFunctionDefinitionVersionPropertiesFormat": { + "description": "Network function definition version properties.", + "discriminator": "networkFunctionType", + "required": [ + "networkFunctionType" + ], + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network function definition version resource." + }, + "versionState": { + "readOnly": true, + "description": "The network function definition version state.", + "$ref": "#/definitions/VersionState" + }, + "description": { + "type": "string", + "description": "The network function definition version description." + }, + "deployParameters": { + "type": "string", + "description": "The deployment parameters of the network function definition version." + }, + "networkFunctionType": { + "description": "The network function type.", + "$ref": "./common.json#/definitions/NetworkFunctionType" + } + } + }, + "ContainerizedNetworkFunctionDefinitionVersion": { + "description": "Containerized network function network function definition version properties.", + "x-ms-discriminator-value": "ContainerizedNetworkFunction", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkFunctionDefinitionVersionPropertiesFormat" + } + ], + "properties": { + "networkFunctionTemplate": { + "description": "Containerized network function template.", + "$ref": "#/definitions/ContainerizedNetworkFunctionTemplate" + } + } + }, + "VirtualNetworkFunctionNetworkFunctionDefinitionVersion": { + "description": "Virtual network function network function definition version properties.", + "x-ms-discriminator-value": "VirtualNetworkFunction", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkFunctionDefinitionVersionPropertiesFormat" + } + ], + "properties": { + "networkFunctionTemplate": { + "description": "Virtual network function template.", + "$ref": "#/definitions/VirtualNetworkFunctionTemplate" + } + } + }, + "ContainerizedNetworkFunctionTemplate": { + "description": "Containerized network function template.", + "discriminator": "nfviType", + "required": [ + "nfviType" + ], + "type": "object", + "properties": { + "nfviType": { + "type": "string", + "description": "The network function type.", + "enum": [ + "Unknown", + "AzureArcKubernetes" + ], + "x-ms-enum": { + "name": "ContainerizedNetworkFunctionNFVIType", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "VirtualNetworkFunctionTemplate": { + "description": "Virtual network function template.", + "discriminator": "nfviType", + "required": [ + "nfviType" + ], + "type": "object", + "properties": { + "nfviType": { + "type": "string", + "description": "The network function type.", + "enum": [ + "Unknown", + "AzureCore", + "AzureOperatorNexus" + ], + "x-ms-enum": { + "name": "VirtualNetworkFunctionNFVIType", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AzureArcKubernetesNetworkFunctionTemplate": { + "description": "Azure Arc kubernetes network function template.", + "x-ms-discriminator-value": "AzureArcKubernetes", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ContainerizedNetworkFunctionTemplate" + } + ], + "properties": { + "networkFunctionApplications": { + "type": "array", + "description": "Network function applications.", + "items": { + "$ref": "#/definitions/AzureArcKubernetesNetworkFunctionApplication" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "AzureArcKubernetesNetworkFunctionApplication": { + "description": "Azure arc kubernetes network function application definition.", + "allOf": [ + { + "$ref": "./common.json#/definitions/NetworkFunctionApplication" + } + ], + "type": "object", + "discriminator": "artifactType", + "required": [ + "artifactType" + ], + "properties": { + "artifactType": { + "type": "string", + "description": "The artifact type.", + "enum": [ + "Unknown", + "HelmPackage" + ], + "x-ms-enum": { + "name": "AzureArcKubernetesArtifactType", + "modelAsString": true + } + } + } + }, + "AzureArcKubernetesHelmApplication": { + "description": "Azure arc kubernetes helm application configurations.", + "allOf": [ + { + "$ref": "#/definitions/AzureArcKubernetesNetworkFunctionApplication" + } + ], + "x-ms-discriminator-value": "HelmPackage", + "type": "object", + "properties": { + "artifactProfile": { + "description": "Azure arc kubernetes artifact profile.", + "$ref": "#/definitions/AzureArcKubernetesArtifactProfile" + }, + "deployParametersMappingRuleProfile": { + "description": "Deploy mapping rule profile.", + "$ref": "#/definitions/AzureArcKubernetesDeployMappingRuleProfile" + } + } + }, + "AzureArcKubernetesArtifactProfile": { + "description": "Azure arc kubernetes artifact profile properties.", + "type": "object", + "allOf": [ + { + "$ref": "./common.json#/definitions/ArtifactProfile" + } + ], + "properties": { + "helmArtifactProfile": { + "description": "Helm artifact profile.", + "$ref": "#/definitions/HelmArtifactProfile" + } + } + }, + "HelmArtifactProfile": { + "description": "Helm artifact profile.", + "type": "object", + "properties": { + "helmPackageName": { + "type": "string", + "description": "Helm package name." + }, + "helmPackageVersionRange": { + "type": "string", + "description": "Helm package version range." + }, + "registryValuesPaths": { + "type": "array", + "description": "The registry values path list.", + "items": { + "description": "The registry values path.", + "type": "string" + }, + "x-ms-identifiers": [] + }, + "imagePullSecretsValuesPaths": { + "type": "array", + "description": "The image pull secrets values path list.", + "items": { + "description": "The image pull secrets values path.", + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "AzureArcKubernetesDeployMappingRuleProfile": { + "description": "Azure arc kubernetes deploy mapping rule profile.", + "type": "object", + "allOf": [ + { + "$ref": "./common.json#/definitions/MappingRuleProfile" + } + ], + "properties": { + "helmMappingRuleProfile": { + "description": "The helm mapping rule profile.", + "$ref": "#/definitions/HelmMappingRuleProfile" + } + } + }, + "HelmMappingRuleProfile": { + "description": "Helm mapping rule profile", + "type": "object", + "properties": { + "releaseNamespace": { + "description": "Helm release namespace.", + "type": "string" + }, + "releaseName": { + "description": "Helm release name.", + "type": "string" + }, + "helmPackageVersion": { + "description": "Helm package version.", + "type": "string" + }, + "values": { + "description": "Helm release values.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "options": { + "type": "object", + "description": "The helm deployment options", + "properties": { + "installOptions": { + "$ref": "#/definitions/HelmInstallOptions", + "description": "The helm deployment install options" + }, + "upgradeOptions": { + "$ref": "#/definitions/HelmUpgradeOptions", + "description": "The helm deployment upgrade options" + } + } + } + } + }, + "HelmInstallOptions": { + "type": "object", + "description": "The helm deployment install options", + "properties": { + "atomic": { + "type": "string", + "description": "The helm deployment atomic options" + }, + "wait": { + "type": "string", + "description": "The helm deployment wait options" + }, + "timeout": { + "type": "string", + "description": "The helm deployment timeout options" + } + } + }, + "HelmUpgradeOptions": { + "type": "object", + "description": "The helm deployment install options", + "properties": { + "atomic": { + "type": "string", + "description": "The helm deployment atomic options" + }, + "wait": { + "type": "string", + "description": "The helm deployment wait options" + }, + "timeout": { + "type": "string", + "description": "The helm deployment timeout options" + } + } + }, + "AzureCoreNetworkFunctionTemplate": { + "description": "Azure virtual network function template.", + "x-ms-discriminator-value": "AzureCore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/VirtualNetworkFunctionTemplate" + } + ], + "properties": { + "networkFunctionApplications": { + "type": "array", + "description": "Network function applications.", + "items": { + "$ref": "#/definitions/AzureCoreNetworkFunctionApplication" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "AzureOperatorNexusNetworkFunctionTemplate": { + "description": "Azure Operator Distributed Services network function template.", + "x-ms-discriminator-value": "AzureOperatorNexus", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/VirtualNetworkFunctionTemplate" + } + ], + "properties": { + "networkFunctionApplications": { + "type": "array", + "description": "Network function applications.", + "items": { + "$ref": "#/definitions/AzureOperatorNexusNetworkFunctionApplication" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "AzureCoreNetworkFunctionApplication": { + "description": "Azure virtual network function application definition.", + "allOf": [ + { + "$ref": "./common.json#/definitions/NetworkFunctionApplication" + } + ], + "type": "object", + "discriminator": "artifactType", + "required": [ + "artifactType" + ], + "properties": { + "artifactType": { + "type": "string", + "description": "The artifact type.", + "enum": [ + "Unknown", + "VhdImageFile", + "ArmTemplate" + ], + "x-ms-enum": { + "name": "AzureCoreArtifactType", + "modelAsString": true + } + } + } + }, + "AzureOperatorNexusNetworkFunctionApplication": { + "description": "Azure Operator Distributed Services network function application definition.", + "allOf": [ + { + "$ref": "./common.json#/definitions/NetworkFunctionApplication" + } + ], + "type": "object", + "discriminator": "artifactType", + "required": [ + "artifactType" + ], + "properties": { + "artifactType": { + "type": "string", + "description": "The artifact type.", + "enum": [ + "Unknown", + "ImageFile", + "ArmTemplate" + ], + "x-ms-enum": { + "name": "AzureOperatorNexusArtifactType", + "modelAsString": true + } + } + } + }, + "AzureCoreNetworkFunctionVhdApplication": { + "description": "Azure core network function vhd application definition.", + "allOf": [ + { + "$ref": "#/definitions/AzureCoreNetworkFunctionApplication" + } + ], + "x-ms-discriminator-value": "VhdImageFile", + "type": "object", + "properties": { + "artifactProfile": { + "description": "Azure vhd image artifact profile.", + "$ref": "#/definitions/AzureCoreVhdImageArtifactProfile" + }, + "deployParametersMappingRuleProfile": { + "description": "Deploy mapping rule profile.", + "$ref": "#/definitions/AzureCoreVhdImageDeployMappingRuleProfile" + } + } + }, + "AzureCoreNetworkFunctionArmTemplateApplication": { + "description": "Azure core network function Template application definition.", + "allOf": [ + { + "$ref": "#/definitions/AzureCoreNetworkFunctionApplication" + } + ], + "x-ms-discriminator-value": "ArmTemplate", + "type": "object", + "properties": { + "artifactProfile": { + "description": "Azure template artifact profile.", + "$ref": "#/definitions/AzureCoreArmTemplateArtifactProfile" + }, + "deployParametersMappingRuleProfile": { + "description": "Deploy mapping rule profile.", + "$ref": "#/definitions/AzureCoreArmTemplateDeployMappingRuleProfile" + } + } + }, + "AzureOperatorNexusNetworkFunctionImageApplication": { + "description": "Azure Operator Distributed Services network function image application definition.", + "allOf": [ + { + "$ref": "#/definitions/AzureOperatorNexusNetworkFunctionApplication" + } + ], + "x-ms-discriminator-value": "ImageFile", + "type": "object", + "properties": { + "artifactProfile": { + "description": "Azure Operator Distributed Services image artifact profile.", + "$ref": "#/definitions/AzureOperatorNexusImageArtifactProfile" + }, + "deployParametersMappingRuleProfile": { + "description": "Deploy mapping rule profile.", + "$ref": "#/definitions/AzureOperatorNexusImageDeployMappingRuleProfile" + } + } + }, + "AzureOperatorNexusNetworkFunctionArmTemplateApplication": { + "description": "Azure Operator Distributed Services network function Template application definition.", + "allOf": [ + { + "$ref": "#/definitions/AzureOperatorNexusNetworkFunctionApplication" + } + ], + "x-ms-discriminator-value": "ArmTemplate", + "type": "object", + "properties": { + "artifactProfile": { + "description": "Azure Operator Distributed Services Template artifact profile.", + "$ref": "#/definitions/AzureOperatorNexusArmTemplateArtifactProfile" + }, + "deployParametersMappingRuleProfile": { + "description": "Deploy mapping rule profile.", + "$ref": "#/definitions/AzureOperatorNexusArmTemplateDeployMappingRuleProfile" + } + } + }, + "AzureCoreVhdImageArtifactProfile": { + "description": "Azure vhd artifact profile properties.", + "type": "object", + "allOf": [ + { + "$ref": "./common.json#/definitions/ArtifactProfile" + } + ], + "properties": { + "vhdArtifactProfile": { + "description": "Vhd artifact profile.", + "$ref": "#/definitions/VhdImageArtifactProfile" + } + } + }, + "AzureCoreArmTemplateArtifactProfile": { + "description": "Azure template artifact profile properties.", + "type": "object", + "allOf": [ + { + "$ref": "./common.json#/definitions/ArtifactProfile" + } + ], + "properties": { + "templateArtifactProfile": { + "description": "Template artifact profile.", + "$ref": "#/definitions/ArmTemplateArtifactProfile" + } + } + }, + "AzureOperatorNexusImageArtifactProfile": { + "description": "Azure Operator Distributed Services image artifact profile properties.", + "type": "object", + "allOf": [ + { + "$ref": "./common.json#/definitions/ArtifactProfile" + } + ], + "properties": { + "imageArtifactProfile": { + "description": "Image artifact profile.", + "$ref": "#/definitions/ImageArtifactProfile" + } + } + }, + "AzureOperatorNexusArmTemplateArtifactProfile": { + "description": "Azure Operator Distributed Services vhd artifact profile properties.", + "type": "object", + "allOf": [ + { + "$ref": "./common.json#/definitions/ArtifactProfile" + } + ], + "properties": { + "templateArtifactProfile": { + "description": "Template artifact profile.", + "$ref": "#/definitions/ArmTemplateArtifactProfile" + } + } + }, + "AzureCoreVhdImageDeployMappingRuleProfile": { + "description": "Azure vhd deploy mapping rule profile.", + "type": "object", + "allOf": [ + { + "$ref": "./common.json#/definitions/MappingRuleProfile" + } + ], + "properties": { + "vhdImageMappingRuleProfile": { + "description": "The vhd mapping rule profile.", + "$ref": "#/definitions/VhdImageMappingRuleProfile" + } + } + }, + "AzureCoreArmTemplateDeployMappingRuleProfile": { + "description": "Azure template deploy mapping rule profile.", + "type": "object", + "allOf": [ + { + "$ref": "./common.json#/definitions/MappingRuleProfile" + } + ], + "properties": { + "templateMappingRuleProfile": { + "description": "The template mapping rule profile.", + "$ref": "#/definitions/ArmTemplateMappingRuleProfile" + } + } + }, + "AzureOperatorNexusImageDeployMappingRuleProfile": { + "description": "Azure Operator Distributed Services image deploy mapping rule profile.", + "type": "object", + "allOf": [ + { + "$ref": "./common.json#/definitions/MappingRuleProfile" + } + ], + "properties": { + "imageMappingRuleProfile": { + "description": "The vhd mapping rule profile.", + "$ref": "#/definitions/ImageMappingRuleProfile" + } + } + }, + "AzureOperatorNexusArmTemplateDeployMappingRuleProfile": { + "description": "Azure Operator Distributed Services template deploy mapping rule profile.", + "type": "object", + "allOf": [ + { + "$ref": "./common.json#/definitions/MappingRuleProfile" + } + ], + "properties": { + "templateMappingRuleProfile": { + "description": "The template mapping rule profile.", + "$ref": "#/definitions/ArmTemplateMappingRuleProfile" + } + } + }, + "VhdImageArtifactProfile": { + "description": "Vhd artifact profile.", + "type": "object", + "properties": { + "vhdName": { + "type": "string", + "description": "Vhd name." + }, + "vhdVersion": { + "type": "string", + "description": "Vhd version." + } + } + }, + "VhdImageMappingRuleProfile": { + "description": "Vhd mapping rule profile", + "type": "object", + "properties": { + "userConfiguration": { + "description": "List of values.", + "type": "string" + } + } + }, + "ArmTemplateArtifactProfile": { + "description": "Template artifact profile.", + "type": "object", + "properties": { + "templateName": { + "type": "string", + "description": "Template name." + }, + "templateVersion": { + "type": "string", + "description": "Template version." + } + } + }, + "ArmTemplateMappingRuleProfile": { + "description": "Template mapping rule profile", + "type": "object", + "properties": { + "templateParameters": { + "description": "List of template parameters.", + "type": "string" + } + } + }, + "ImageArtifactProfile": { + "description": "Image artifact profile.", + "type": "object", + "properties": { + "imageName": { + "type": "string", + "description": "Image name." + }, + "imageVersion": { + "type": "string", + "description": "Image version." + } + } + }, + "ImageMappingRuleProfile": { + "description": "Image mapping rule profile", + "type": "object", + "properties": { + "userConfiguration": { + "description": "List of values.", + "type": "string" + } + } + }, + "VersionState": { + "type": "string", + "description": "The network function definition version state.", + "enum": [ + "Unknown", + "Preview", + "Validating", + "ValidationFailed", + "Active", + "Deprecated" + ], + "x-ms-enum": { + "name": "versionState", + "modelAsString": true + } + }, + "NetworkFunctionDefinitionVersionUpdateState": { + "type": "object", + "description": "Publisher network function definition version update request definition.", + "properties": { + "versionState": { + "description": "The network function definition version state. Only the 'Active' and 'Deprecated' states are allowed for updates. Other states are used for internal state transitioning.", + "$ref": "#/definitions/VersionState", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/networkServiceDesign.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/networkServiceDesign.json new file mode 100644 index 000000000000..3b373dc26b88 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/networkServiceDesign.json @@ -0,0 +1,942 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used by publishers to on-board offerings and manage network functions.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/networkServiceDesignGroups": { + "get": { + "tags": [ + "NetworkServiceDesignGroups" + ], + "operationId": "NetworkServiceDesignGroups_ListByPublisher", + "description": "Gets information of the network service design groups under a publisher.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting network service design group resource.", + "schema": { + "$ref": "#/definitions/NetworkServiceDesignGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get networkServiceDesign groups under publisher resource": { + "$ref": "./examples/NetworkServiceDesignGroupsListByPublisherName.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/networkServiceDesignGroups/{networkServiceDesignGroupName}": { + "delete": { + "tags": [ + "NetworkServiceDesignGroups" + ], + "operationId": "NetworkServiceDesignGroups_Delete", + "description": "Deletes a specified network service design group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. Sets provisioningState to 'Deleting' until the operation is completed. Returns an operation URI that can be queried to find the current state of the operation.", + "headers": { + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "204": { + "description": "Request is successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a network function group resource": { + "$ref": "./examples/NetworkServiceDesignGroupDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "put": { + "tags": [ + "NetworkServiceDesignGroups" + ], + "operationId": "NetworkServiceDesignGroups_CreateOrUpdate", + "description": "Creates or updates a network service design group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkServiceDesignGroup" + }, + "description": "Parameters supplied to the create or update publisher network service design group operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting NetworkServiceDesignGroup sub resource.", + "schema": { + "$ref": "#/definitions/NetworkServiceDesignGroup" + } + }, + "201": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting NetworkServiceDesignGroup sub resource.", + "schema": { + "$ref": "#/definitions/NetworkServiceDesignGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update the network service design group": { + "$ref": "./examples/NetworkServiceDesignGroupCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "NetworkServiceDesignGroups" + ], + "operationId": "NetworkServiceDesignGroups_Get", + "description": "Gets information about the specified networkServiceDesign group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting publisher network service design group resource.", + "schema": { + "$ref": "#/definitions/NetworkServiceDesignGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a networkServiceDesign group resource": { + "$ref": "./examples/NetworkServiceDesignGroupGet.json" + } + } + }, + "patch": { + "tags": [ + "NetworkServiceDesignGroups" + ], + "operationId": "NetworkServiceDesignGroups_Update", + "description": "Updates a network service design groups resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the create or update publisher network service design group operation." + } + ], + "responses": { + "200": { + "description": "Creation or update is successful. The operation returns the resulting network service design group resource.", + "schema": { + "$ref": "#/definitions/NetworkServiceDesignGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update the network service design group resource": { + "$ref": "./examples/NetworkServiceDesignGroupUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/networkServiceDesignGroups/{networkServiceDesignGroupName}/networkServiceDesignVersions/{networkServiceDesignVersionName}": { + "delete": { + "tags": [ + "NetworkServiceDesignVersions" + ], + "operationId": "NetworkServiceDesignVersions_Delete", + "description": "Deletes the specified network service design version.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignVersionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. Sets provisioningState to 'Deleting' until the operation is completed. Returns an operation URI that can be queried to find the current state of the operation.", + "headers": { + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "204": { + "description": "Request is successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a network service design version": { + "$ref": "./examples/NetworkServiceDesignVersionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "put": { + "tags": [ + "NetworkServiceDesignVersions" + ], + "operationId": "NetworkServiceDesignVersions_CreateOrUpdate", + "description": "Creates or updates a network service design version.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignVersionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/networkServiceDesignVersion" + }, + "description": "Parameters supplied to the create or update network service design version operation." + } + ], + "responses": { + "200": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting network service design sub resource.", + "schema": { + "$ref": "#/definitions/networkServiceDesignVersion" + } + }, + "201": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting network service design sub resource.", + "schema": { + "$ref": "#/definitions/networkServiceDesignVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a network service design version resource": { + "$ref": "./examples/NetworkServiceDesignVersionCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "NetworkServiceDesignVersions" + ], + "operationId": "NetworkServiceDesignVersions_Get", + "description": "Gets information about a network service design version.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignVersionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting networkServiceDesignVersion resource.", + "schema": { + "$ref": "#/definitions/networkServiceDesignVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a network service design version resource": { + "$ref": "./examples/NetworkServiceDesignVersionGet.json" + } + } + }, + "patch": { + "tags": [ + "NetworkServiceDesignVersions" + ], + "operationId": "NetworkServiceDesignVersions_Update", + "description": "Updates a network service design version resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignVersionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the create or update network service design version operation." + } + ], + "responses": { + "200": { + "description": "Creation or update is successful. The operation returns the resulting network service design sub resource.", + "schema": { + "$ref": "#/definitions/networkServiceDesignVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update the network service design version tags": { + "$ref": "./examples/NetworkServiceDesignVersionUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/networkServiceDesignGroups/{networkServiceDesignGroupName}/networkServiceDesignVersions": { + "get": { + "tags": [ + "NetworkServiceDesignVersions" + ], + "operationId": "NetworkServiceDesignVersions_ListByNetworkServiceDesignGroup", + "description": "Gets information about a list of network service design versions under a network service design group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting networkServiceDesignVersion resource.", + "schema": { + "$ref": "#/definitions/networkServiceDesignVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Publisher resource": { + "$ref": "./examples/NetworkServiceDesignVersionListByNetworkServiceDesignGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/networkServiceDesignGroups/{networkServiceDesignGroupName}/networkServiceDesignVersions/{networkServiceDesignVersionName}/updateState": { + "post": { + "tags": [ + "NetworkServiceDesignVersions" + ], + "operationId": "NetworkServiceDesignVersions_updateState", + "description": "Update network service design version state.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/NetworkServiceDesignVersionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkServiceDesignVersionUpdateState" + }, + "description": "Parameters supplied to update the state of network service design version." + } + ], + "responses": { + "200": { + "description": "The updated network service design version state.", + "schema": { + "$ref": "#/definitions/NetworkServiceDesignVersionUpdateState" + } + }, + "202": { + "description": "The request of updating network service design version state is accepted.", + "headers": { + "Location": { + "description": "The Location 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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update network service design version state": { + "$ref": "./examples/NetworkServiceDesignVersionUpdateState.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "NetworkServiceDesignGroup": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/NetworkServiceDesignGroupPropertiesFormat", + "description": "network service design group properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "network service design group resource." + }, + "NetworkServiceDesignGroupPropertiesFormat": { + "description": "network service design group properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network service design groups resource." + }, + "description": { + "type": "string", + "description": "The network service design group description." + } + } + }, + "NetworkServiceDesignGroupListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkServiceDesignGroup" + }, + "description": "A list of network service design group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of network service design group resources." + }, + "networkServiceDesignVersionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/networkServiceDesignVersion" + }, + "description": "A list of network service design versions." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to get the next set of results." + } + }, + "description": "A list of network service design versions." + }, + "networkServiceDesignVersion": { + "description": "network service design version.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/networkServiceDesignVersionPropertiesFormat", + "description": "network service design version properties." + } + } + }, + "networkServiceDesignVersionPropertiesFormat": { + "description": "network service design version properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network service design version resource." + }, + "versionState": { + "readOnly": true, + "description": "The network service design version state.", + "$ref": "#/definitions/NSDVersionState" + }, + "description": { + "type": "string", + "description": "The network service design version description." + }, + "configurationGroupSchemaReferences": { + "type": "object", + "additionalProperties": { + "$ref": "./common.json#/definitions/ReferencedResource" + }, + "description": "The configuration schemas to used to define the values." + }, + "nfvisFromSite": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/NfviDetails" + }, + "description": "The nfvis from the site." + }, + "resourceElementTemplates": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceElementTemplate" + }, + "description": "List of resource element template", + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "NfviDetails": { + "type": "object", + "properties": { + "name": { + "description": "The nfvi name.", + "type": "string" + }, + "type": { + "description": "The nfvi type.", + "type": "string" + } + }, + "description": "The nfvi details." + }, + "ResourceElementTemplate": { + "required": [ + "type" + ], + "discriminator": "type", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the resource element template." + }, + "type": { + "$ref": "#/definitions/Type", + "description": "The resource element template type.", + "x-ms-client-name": "ResourceElementType" + }, + "dependsOnProfile": { + "$ref": "./common.json#/definitions/DependsOnProfile", + "description": "The depends on profile." + } + }, + "description": "The resource element template object." + }, + "Type": { + "type": "string", + "description": "The resource element template type.", + "enum": [ + "Unknown", + "ArmResourceDefinition", + "NetworkFunctionDefinition" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true + } + }, + "ArmResourceDefinitionResourceElementTemplateDetails": { + "description": "The arm resource definition resource element template details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceElementTemplate" + } + ], + "properties": { + "configuration": { + "$ref": "#/definitions/ArmResourceDefinitionResourceElementTemplate", + "description": "The resource element template type." + } + }, + "x-ms-discriminator-value": "ArmResourceDefinition" + }, + "ArmResourceDefinitionResourceElementTemplate": { + "type": "object", + "properties": { + "templateType": { + "description": "The template type.", + "$ref": "#/definitions/TemplateType" + }, + "parameterValues": { + "type": "string", + "description": "Name and value pairs that define the parameter values. It can be a well formed escaped JSON string." + }, + "artifactProfile": { + "$ref": "#/definitions/NSDArtifactProfile", + "description": "Artifact profile properties." + } + }, + "description": "The arm template RE." + }, + "NetworkFunctionDefinitionResourceElementTemplateDetails": { + "description": "The network function definition resource element template details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceElementTemplate" + } + ], + "properties": { + "configuration": { + "$ref": "#/definitions/ArmResourceDefinitionResourceElementTemplate", + "description": "The resource element template type." + } + }, + "x-ms-discriminator-value": "NetworkFunctionDefinition" + }, + "NSDArtifactProfile": { + "description": "Artifact profile properties.", + "type": "object", + "properties": { + "artifactStoreReference": { + "$ref": "./common.json#/definitions/ReferencedResource", + "description": "The artifact store resource id" + }, + "artifactName": { + "type": "string", + "description": "Artifact name." + }, + "artifactVersion": { + "type": "string", + "description": "Artifact version." + } + } + }, + "TemplateType": { + "type": "string", + "description": "The template type.", + "enum": [ + "Unknown", + "ArmTemplate" + ], + "x-ms-enum": { + "name": "templateType", + "modelAsString": true + } + }, + "ConfigurationGenerationType": { + "type": "string", + "description": "The configuration generation type.", + "enum": [ + "Unknown", + "HandlebarTemplate" + ], + "x-ms-enum": { + "name": "configurationGenerationType", + "modelAsString": true + } + }, + "NSDVersionState": { + "type": "string", + "description": "The network service design version state.", + "enum": [ + "Unknown", + "Preview", + "Active", + "Deprecated" + ], + "x-ms-enum": { + "name": "versionState", + "modelAsString": true + } + }, + "NetworkServiceDesignVersionUpdateState": { + "type": "object", + "description": "Publisher network service design version update request definition.", + "properties": { + "versionState": { + "description": "The network service design version state.", + "$ref": "#/definitions/NSDVersionState", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/operation.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/operation.json new file mode 100644 index 000000000000..66efc6b5cfbe --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/operation.json @@ -0,0 +1,74 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage the operations.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.HybridNetwork/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Gets a list of the operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Returns a list of operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registration Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/publisher.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/publisher.json new file mode 100644 index 000000000000..22e532de24d0 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/publisher.json @@ -0,0 +1,1269 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used by publishers to on-board offerings and manage network functions.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/publishers": { + "get": { + "tags": [ + "Publishers" + ], + "operationId": "Publishers_ListBySubscription", + "description": "Lists all the publishers in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of publisher resources.", + "schema": { + "$ref": "#/definitions/PublisherListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all publisher resources in a subscription": { + "$ref": "./examples/PublisherListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers": { + "get": { + "tags": [ + "Publishers" + ], + "operationId": "Publishers_ListByResourceGroup", + "description": "Lists all the publishers in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of publisher resources.", + "schema": { + "$ref": "#/definitions/PublisherListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all publisher resources in a resource group": { + "$ref": "./examples/PublisherListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}": { + "delete": { + "tags": [ + "Publishers" + ], + "operationId": "Publishers_Delete", + "description": "Deletes the specified publisher.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. Sets provisioningState to 'Deleting' until the operation is completed. Returns an operation URI that can be queried to find the current state of the operation.", + "headers": { + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "204": { + "description": "Request is successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a publisher resource": { + "$ref": "./examples/PublisherDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Publishers" + ], + "operationId": "Publishers_Get", + "description": "Gets information about the specified publisher.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting publisher resource.", + "schema": { + "$ref": "#/definitions/Publisher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a publisher resource": { + "$ref": "./examples/PublisherGet.json" + } + } + }, + "put": { + "tags": [ + "Publishers" + ], + "operationId": "Publishers_CreateOrUpdate", + "description": "Creates or updates a publisher.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/Publisher" + }, + "description": "Parameters supplied to the create publisher operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting publisher resource.", + "schema": { + "$ref": "#/definitions/Publisher" + } + }, + "201": { + "description": "Create or update operation has been completed successfully. The header contains 'Azure-AsyncOperation' header pointing to an operations resource. The operation URI can be queried to find the current state of the operation.", + "schema": { + "$ref": "#/definitions/Publisher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a publisher resource": { + "$ref": "./examples/PublisherCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Publishers" + ], + "operationId": "Publishers_Update", + "description": "Update a publisher resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the create publisher operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. Request is successful.", + "schema": { + "$ref": "#/definitions/Publisher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a publisher tags": { + "$ref": "./examples/PublisherUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/artifactStores": { + "get": { + "tags": [ + "ArtifactStores" + ], + "operationId": "ArtifactStores_ListByPublisher", + "description": "Gets information of the ArtifactStores under publisher.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting ArtifactStoreVersion resource.", + "schema": { + "$ref": "#/definitions/ArtifactStoreListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get application groups under a publisher resource": { + "$ref": "./examples/ArtifactStoresListByPublisherName.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/artifactStores/{artifactStoreName}": { + "delete": { + "tags": [ + "ArtifactStores" + ], + "operationId": "ArtifactStores_Delete", + "description": "Deletes the specified artifact store.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactStoreParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. Sets provisioningState to 'Deleting' until the operation is completed. Returns an operation URI that can be queried to find the current state of the operation.", + "headers": { + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "204": { + "description": "Request is successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a artifact store of publisher resource": { + "$ref": "./examples/ArtifactStoreDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "put": { + "tags": [ + "ArtifactStores" + ], + "operationId": "ArtifactStores_CreateOrUpdate", + "description": "Creates or updates a artifact store.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactStoreParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactStore" + }, + "description": "Parameters supplied to the create or update application group operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting ArtifactStore sub resource.", + "schema": { + "$ref": "#/definitions/ArtifactStore" + } + }, + "201": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting ArtifactStore sub resource.", + "schema": { + "$ref": "#/definitions/ArtifactStore" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update an artifact store of publisher resource": { + "$ref": "./examples/ArtifactStoreCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ArtifactStores" + ], + "operationId": "ArtifactStores_Get", + "description": "Gets information about the specified artifact store.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactStoreParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting ArtifactStore resource.", + "schema": { + "$ref": "#/definitions/ArtifactStore" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a artifact store resource": { + "$ref": "./examples/ArtifactStoreGet.json" + } + } + }, + "patch": { + "tags": [ + "ArtifactStores" + ], + "operationId": "ArtifactStores_Update", + "description": "Update artifact store resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactStoreParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the create or update application group operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Creation or update is successful. The operation returns the resulting ArtifactStore sub resource.", + "schema": { + "$ref": "#/definitions/ArtifactStore" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update artifact store resource tags": { + "$ref": "./examples/ArtifactStoreUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/artifactStores/{artifactStoreName}/artifactManifests": { + "get": { + "tags": [ + "ArtifactManifests" + ], + "operationId": "ArtifactManifests_ListByArtifactStore", + "description": "Gets information about the artifact manifest.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactStoreParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting ArtifactManifest resource.", + "schema": { + "$ref": "#/definitions/ArtifactManifestListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get artifact manifest list resource": { + "$ref": "./examples/ArtifactManifestListByArtifactStore.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/artifactStores/{artifactStoreName}/artifactManifests/{artifactManifestName}": { + "delete": { + "tags": [ + "ArtifactManifests" + ], + "operationId": "ArtifactManifests_Delete", + "description": "Deletes the specified artifact manifest.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactStoreParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactManifestParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. Sets provisioningState to 'Deleting' until the operation is completed. Returns an operation URI that can be queried to find the current state of the operation.", + "headers": { + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "204": { + "description": "Request is successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a artifact manifest resource": { + "$ref": "./examples/ArtifactManifestDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "put": { + "tags": [ + "ArtifactManifests" + ], + "operationId": "ArtifactManifests_CreateOrUpdate", + "description": "Creates or updates a artifact manifest.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactStoreParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactManifestParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactManifest" + }, + "description": "Parameters supplied to the create or update artifact manifest operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting ArtifactManifest sub resource.", + "schema": { + "$ref": "#/definitions/ArtifactManifest" + } + }, + "201": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting ArtifactManifest sub resource.", + "schema": { + "$ref": "#/definitions/ArtifactManifest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update the artifact manifest resource": { + "$ref": "./examples/ArtifactManifestCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ArtifactManifests" + ], + "operationId": "ArtifactManifests_Get", + "description": "Gets information about a artifact manifest resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactStoreParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactManifestParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting ArtifactManifest resource.", + "schema": { + "$ref": "#/definitions/ArtifactManifest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a artifact manifest resource": { + "$ref": "./examples/ArtifactManifestGet.json" + } + } + }, + "patch": { + "tags": [ + "ArtifactManifests" + ], + "operationId": "ArtifactManifests_Update", + "description": "Updates a artifact manifest resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactStoreParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactManifestParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the create or update artifact manifest operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Creation or update is successful. The operation returns the resulting ArtifactManifest sub resource.", + "schema": { + "$ref": "#/definitions/ArtifactManifest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a artifact manifest resource tags": { + "$ref": "./examples/ArtifactManifestUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/artifactStores/{artifactStoreName}/artifactManifests/{artifactManifestName}/listCredential": { + "post": { + "tags": [ + "ArtifactManifests" + ], + "operationId": "ArtifactManifests_ListCredential", + "description": "List credential for publishing artifacts defined in artifact manifest.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactStoreParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactManifestParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operations returns the credential for publishing artifacts.", + "schema": { + "$ref": "./common.json#/definitions/ArtifactAccessCredential" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List a credential for artifact manifest": { + "$ref": "./examples/ArtifactManifestListCredential.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/artifactStores/{artifactStoreName}/artifactManifests/{artifactManifestName}/updateState": { + "post": { + "tags": [ + "ArtifactManifests" + ], + "operationId": "ArtifactManifests_UpdateState", + "description": "Update state for artifact manifest.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactStoreParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactManifestParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactManifestUpdateState" + }, + "description": "Parameters supplied to update the state of artifact manifest." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operations returns the credential for publishing artifacts.", + "schema": { + "$ref": "#/definitions/ArtifactManifestUpdateState" + } + }, + "202": { + "description": "Request of updating artifact manifest state is accepted.", + "headers": { + "Location": { + "description": "The Location 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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update artifact manifest state": { + "$ref": "./examples/ArtifactManifestUpdateState.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "Publisher": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/PublisherPropertiesFormat", + "description": "Publisher properties." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed identity of the publisher, if configured." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "publisher resource." + }, + "PublisherPropertiesFormat": { + "description": "publisher properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the publisher resource." + }, + "scope": { + "description": "The publisher scope.", + "$ref": "./common.json#/definitions/PublisherScope", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "PublisherListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Publisher" + }, + "description": "A list of publishers." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of publishers." + }, + "ArtifactStore": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/ArtifactStorePropertiesFormat", + "description": "ArtifactStores properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Artifact store properties." + }, + "ArtifactStorePropertiesFormat": { + "description": "Artifact store properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application groups resource." + }, + "storeType": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The artifact store type.", + "enum": [ + "Unknown", + "AzureContainerRegistry", + "AzureStorageAccount" + ], + "x-ms-enum": { + "name": "ArtifactStoreType", + "modelAsString": true + } + }, + "replicationStrategy": { + "type": "string", + "description": "The replication strategy.", + "enum": [ + "Unknown", + "SingleReplication" + ], + "x-ms-enum": { + "name": "ArtifactReplicationStrategy", + "modelAsString": true + } + }, + "managedResourceGroupConfiguration": { + "type": "object", + "properties": { + "name": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The managed resource group name." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The managed resource group location." + } + } + }, + "storageResourceId": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "description": "The created storage resource id" + } + } + }, + "ArtifactStoreListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ArtifactStore" + }, + "description": "A list of artifact stores." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of artifact stores." + }, + "ArtifactManifestListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ArtifactManifest" + }, + "description": "A list of artifact manifests." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to get the next set of results." + } + }, + "description": "A list of artifact manifests." + }, + "ArtifactManifest": { + "description": "Artifact manifest properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/ArtifactManifestPropertiesFormat", + "description": "Artifact manifest properties." + } + } + }, + "ArtifactManifestPropertiesFormat": { + "description": "Artifact manifest properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the ArtifactManifest resource." + }, + "artifactManifestState": { + "readOnly": true, + "description": "The artifact manifest state.", + "$ref": "#/definitions/ArtifactManifestState" + }, + "artifacts": { + "type": "array", + "items": { + "$ref": "#/definitions/ManifestArtifactFormat" + }, + "x-ms-identifiers": [ + "artifactName", + "artifactType", + "artifactVersion" + ], + "description": "The artifacts list." + } + } + }, + "ManifestArtifactFormat": { + "description": "Manifest artifact properties.", + "type": "object", + "properties": { + "artifactName": { + "type": "string", + "description": "The artifact name", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "artifactType": { + "$ref": "#/definitions/ArtifactType", + "description": "The artifact type.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "artifactVersion": { + "type": "string", + "description": "The artifact version.", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ArtifactManifestUpdateState": { + "description": "The artifact manifest updating request payload. Only the 'Uploaded' state is allowed for updates. Other states are used for internal state transitioning.", + "type": "object", + "properties": { + "artifactManifestState": { + "description": "The artifact manifest state.", + "$ref": "#/definitions/ArtifactManifestState", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ArtifactManifestState": { + "type": "string", + "description": "The artifact manifest state.", + "enum": [ + "Unknown", + "Uploading", + "Uploaded", + "Validating", + "ValidationFailed", + "Succeeded" + ], + "x-ms-enum": { + "name": "ArtifactManifestState", + "modelAsString": true + } + }, + "ArtifactType": { + "type": "string", + "description": "The artifact type.", + "enum": [ + "Unknown", + "OCIArtifact", + "VhdImageFile", + "ArmTemplate", + "ImageFile" + ], + "x-ms-enum": { + "name": "ArtifactType", + "modelAsString": true + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/pureProxyArtifact.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/pureProxyArtifact.json new file mode 100644 index 000000000000..65656346f4ba --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/pureProxyArtifact.json @@ -0,0 +1,359 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage the network function publisher in a Hybrid Network resource provider.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/artifactStores/{artifactStoreName}/artifacts": { + "get": { + "tags": [ + "ProxyArtifact" + ], + "operationId": "ProxyArtifact_List", + "description": "Lists all the available artifacts in the parent Artifact Store.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactStoreParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of available artifacts.", + "schema": { + "$ref": "#/definitions/ProxyArtifactOverviewListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List artifacts under an artifact store": { + "$ref": "./examples/PureProxyArtifact/ArtifactList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/artifactStores/{artifactStoreName}/artifactVersions": { + "get": { + "tags": [ + "ProxyArtifact" + ], + "operationId": "ProxyArtifact_Get", + "description": "Get a Artifact overview information.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactStoreParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a proxy artifact overview.", + "schema": { + "$ref": "#/definitions/ProxyArtifactVersionsOverviewListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get an artifact overview": { + "$ref": "./examples/PureProxyArtifact/ArtifactGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/artifactStores/{artifactStoreName}/artifactVersions/{artifactVersionName}": { + "patch": { + "tags": [ + "ProxyArtifact" + ], + "operationId": "ProxyArtifact_UpdateState", + "description": "Change artifact state defined in artifact store.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PublisherNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactStoreParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactNameParameter" + }, + { + "$ref": "./common.json#/parameters/ArtifactVersionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactChangeState" + }, + "description": "Parameters supplied to update the state of artifact manifest." + } + ], + "responses": { + "200": { + "description": "Request is successful. Artifact State updated successfully", + "schema": { + "$ref": "#/definitions/ProxyArtifactVersionsListOverview" + } + }, + "202": { + "description": "Request of updating artifact state is accepted.", + "headers": { + "Location": { + "description": "The Location 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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update an artifact state": { + "$ref": "./examples/PureProxyArtifact/ArtifactChangeState.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "ProxyArtifactOverviewListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProxyArtifactListOverview" + }, + "description": "A list of available proxy artifacts." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "The proxy artifact list result." + }, + "ProxyArtifactVersionsOverviewListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProxyArtifactVersionsListOverview" + }, + "description": "A list of available proxy artifacts." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "The proxy artifact list result." + }, + "ProxyArtifactVersionsListOverview": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": false, + "readOnly": true, + "$ref": "#/definitions/ProxyArtifactOverviewPropertiesValue", + "description": "Proxy Artifact overview properties." + } + }, + "readOnly": true, + "description": "The proxy artifact overview." + }, + "ProxyArtifactListOverview": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "readOnly": true, + "description": "The proxy artifact overview." + }, + "ProxyArtifactOverview": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": false, + "readOnly": true, + "$ref": "#/definitions/ProxyArtifactOverviewPropertiesFormat", + "description": "Proxy Artifact properties overview." + } + }, + "readOnly": true, + "description": "The proxy artifact overview." + }, + "ProxyArtifactOverviewPropertiesFormat": { + "description": "Proxy Artifact overview properties.", + "type": "object", + "properties": { + "artifactVersions": { + "type": "array", + "items": { + "$ref": "#/definitions/ProxyArtifactOverviewPropertiesValue" + }, + "description": "The proxy artifact overview properties.", + "x-ms-identifiers": [] + } + } + }, + "ProxyArtifactOverviewPropertiesValue": { + "type": "object", + "properties": { + "artifactType": { + "$ref": "./publisher.json#/definitions/ArtifactType", + "description": "The artifact type." + }, + "artifactVersion": { + "type": "string", + "description": "The artifact version." + }, + "artifactState": { + "$ref": "#/definitions/ArtifactState", + "description": "The artifact state" + } + } + }, + "ArtifactChangeState": { + "description": "The artifact updating request payload.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ArtifactChangeStateProperties", + "description": "Artifact update state properties." + } + } + }, + "ArtifactChangeStateProperties": { + "description": "The artifact update state properties.", + "type": "object", + "properties": { + "artifactState": { + "$ref": "#/definitions/ArtifactState", + "description": "The artifact state" + } + } + }, + "ArtifactState": { + "type": "string", + "description": "The artifact state.", + "enum": [ + "Unknown", + "Preview", + "Active", + "Deprecated" + ], + "x-ms-enum": { + "name": "ArtifactState", + "modelAsString": true + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/site.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/site.json new file mode 100644 index 000000000000..8d51d538ef40 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/site.json @@ -0,0 +1,453 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage the hybrid network site.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/sites/{siteName}": { + "delete": { + "tags": [ + "Sites" + ], + "operationId": "Sites_Delete", + "description": "Deletes the specified network site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/SiteNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation.", + "headers": { + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete network site": { + "$ref": "./examples/SiteDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Sites" + ], + "operationId": "Sites_Get", + "description": "Gets information about the specified network site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/SiteNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting network site resource.", + "schema": { + "$ref": "#/definitions/Site" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network site": { + "$ref": "./examples/SiteGet.json" + } + } + }, + "put": { + "tags": [ + "Sites" + ], + "operationId": "Sites_CreateOrUpdate", + "description": "Creates or updates a network site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/SiteNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Site" + }, + "description": "Parameters supplied to the create or update network site operation." + } + ], + "responses": { + "200": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting network site resource.", + "schema": { + "$ref": "#/definitions/Site" + } + }, + "201": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting network site resource.", + "schema": { + "$ref": "#/definitions/Site" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create network site": { + "$ref": "./examples/SiteCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Sites" + ], + "operationId": "Sites_UpdateTags", + "description": "Updates a site update tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/SiteNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network site tags." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network site resource.", + "schema": { + "$ref": "#/definitions/Site" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update network site tags": { + "$ref": "./examples/SiteUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/sites": { + "get": { + "tags": [ + "Sites" + ], + "operationId": "Sites_ListBySubscription", + "description": "Lists all sites in the network service in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of hybrid network site resources.", + "schema": { + "$ref": "#/definitions/SiteListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all hybrid network sites in a subscription.": { + "$ref": "./examples/SiteListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/sites": { + "get": { + "tags": [ + "Sites" + ], + "operationId": "Sites_ListByResourceGroup", + "description": "Lists all sites in the network service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of network site resources.", + "schema": { + "$ref": "#/definitions/SiteListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all network sites": { + "$ref": "./examples/SiteListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Site": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/SitePropertiesFormat", + "description": "Site properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Site resource." + }, + "SitePropertiesFormat": { + "type": "object", + "description": "Site properties.", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the site resource. **TODO**: Confirm if this is needed." + }, + "nfvis": { + "type": "array", + "items": { + "$ref": "#/definitions/NFVIs" + }, + "description": "List of NFVIs", + "x-ms-identifiers": [ + "name" + ] + }, + "siteNetworkServiceReferences": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./common.json#/definitions/ReferencedResource" + }, + "description": "The list of site network services on the site.", + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "SiteListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Site" + }, + "description": "A list of sites in a resource group." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for sites API service call." + }, + "NFVIs": { + "required": [ + "nfviType" + ], + "discriminator": "nfviType", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the nfvi." + }, + "nfviType": { + "$ref": "./common.json#/definitions/NFVIType", + "description": "The NFVI type." + } + }, + "description": "The NFVI object." + }, + "AzureCoreNFVIDetails": { + "description": "The Azure Core NFVI detail.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NFVIs" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Location of the Azure core." + } + }, + "x-ms-discriminator-value": "AzureCore" + }, + "AzureArcK8sClusterNFVIDetails": { + "description": "The AzureArcK8sCluster NFVI detail.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NFVIs" + } + ], + "properties": { + "customLocationReference": { + "$ref": "./common.json#/definitions/ReferencedResource", + "description": "The reference to the custom location." + } + }, + "x-ms-discriminator-value": "AzureArcKubernetes" + }, + "AzureOperatorNexusClusterNFVIDetails": { + "description": "The AzureOperatorNexusCluster NFVI detail.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NFVIs" + } + ], + "properties": { + "customLocationReference": { + "$ref": "./common.json#/definitions/ReferencedResource", + "description": "The reference to the custom location." + } + }, + "x-ms-discriminator-value": "AzureOperatorNexus" + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/siteNetworkService.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/siteNetworkService.json new file mode 100644 index 000000000000..a26520609c10 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/siteNetworkService.json @@ -0,0 +1,467 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage the hybrid network site network service.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/siteNetworkServices/{siteNetworkServiceName}": { + "delete": { + "tags": [ + "SiteNetworkServices" + ], + "operationId": "SiteNetworkServices_Delete", + "description": "Deletes the specified site network service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/SiteNetworkServiceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation.", + "headers": { + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete network site": { + "$ref": "./examples/SiteNetworkServiceDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "SiteNetworkServices" + ], + "operationId": "SiteNetworkServices_Get", + "description": "Gets information about the specified site network service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/SiteNetworkServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting network site resource.", + "schema": { + "$ref": "#/definitions/SiteNetworkService" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network site": { + "$ref": "./examples/SiteNetworkServiceGet.json" + } + } + }, + "put": { + "tags": [ + "SiteNetworkServices" + ], + "operationId": "SiteNetworkServices_CreateOrUpdate", + "description": "Creates or updates a network site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/SiteNetworkServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SiteNetworkService" + }, + "description": "Parameters supplied to the create or update site network service operation." + } + ], + "responses": { + "200": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting site network service resource.", + "schema": { + "$ref": "#/definitions/SiteNetworkService" + } + }, + "201": { + "description": "Create or update operation has been completed successfully. The operation returns the resulting site network service resource.", + "schema": { + "$ref": "#/definitions/SiteNetworkService" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create site network service": { + "$ref": "./examples/SiteNetworkServiceCreate.json" + }, + "Create first party site network service": { + "$ref": "./examples/SiteNetworkServiceFirstPartyCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "SiteNetworkServices" + ], + "operationId": "SiteNetworkServices_UpdateTags", + "description": "Updates a site update tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/SiteNetworkServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network site tags." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting site network service resource.", + "schema": { + "$ref": "#/definitions/SiteNetworkService" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update network site tags": { + "$ref": "./examples/SiteNetworkServiceUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/siteNetworkServices": { + "get": { + "tags": [ + "SiteNetworkServices" + ], + "operationId": "SiteNetworkServices_ListBySubscription", + "description": "Lists all sites in the network service in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of network site resources.", + "schema": { + "$ref": "#/definitions/SiteNetworkServiceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all hybrid network sites in a subscription.": { + "$ref": "./examples/SiteNetworkServiceListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/siteNetworkServices": { + "get": { + "tags": [ + "SiteNetworkServices" + ], + "operationId": "SiteNetworkServices_ListByResourceGroup", + "description": "Lists all site network services.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of network site resources.", + "schema": { + "$ref": "#/definitions/SiteNetworkServiceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all network sites": { + "$ref": "./examples/SiteNetworkServiceListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "SiteNetworkService": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/SiteNetworkServicePropertiesFormat", + "description": "Site network service properties." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed identity of the Site network service, if configured." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the site network service." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Site network service resource." + }, + "SiteNetworkServicePropertiesFormat": { + "type": "object", + "description": "Site network service properties.", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the site network service resource." + }, + "managedResourceGroupConfiguration": { + "$ref": "./common.json#/definitions/ManagedResourceGroupConfiguration" + }, + "siteReference": { + "$ref": "./common.json#/definitions/ReferencedResource", + "description": "The site details" + }, + "publisherName": { + "readOnly": true, + "type": "string", + "description": "The publisher name for the site network service." + }, + "publisherScope": { + "readOnly": true, + "$ref": "./common.json#/definitions/PublisherScope", + "description": "The scope of the publisher." + }, + "networkServiceDesignGroupName": { + "readOnly": true, + "type": "string", + "description": "The network service design group name for the site network service." + }, + "networkServiceDesignVersionName": { + "readOnly": true, + "type": "string", + "description": "The network service design version for the site network service." + }, + "networkServiceDesignVersionOfferingLocation": { + "readOnly": true, + "type": "string", + "description": "The location of the network service design offering." + }, + "networkServiceDesignVersionResourceReference": { + "$ref": "./common.json#/definitions/DeploymentResourceIdReference", + "description": "The network service design version resource reference." + }, + "desiredStateConfigurationGroupValueReferences": { + "type": "object", + "additionalProperties": { + "$ref": "./common.json#/definitions/ReferencedResource" + }, + "description": "The goal state of the site network service resource. This has references to the configuration group value objects that describe the desired state of the site network service." + }, + "lastStateNetworkServiceDesignVersionName": { + "readOnly": true, + "type": "string", + "description": "The network service design version for the site network service." + }, + "lastStateConfigurationGroupValueReferences": { + "type": "object", + "readOnly": true, + "additionalProperties": { + "$ref": "./common.json#/definitions/ReferencedResource" + }, + "description": "The last state of the site network service resource." + } + } + }, + "SiteNetworkServiceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SiteNetworkService" + }, + "description": "A list of site network services in a resource group." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for site network services API service call." + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this Sku", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "description": "The SKU tier based on the SKU name.", + "enum": [ + "Basic", + "Standard" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + }, + "description": "Sku, to be associated with a SiteNetworkService.", + "required": [ + "name" + ] + } + } +} diff --git a/specification/hybridnetwork/resource-manager/readme.md b/specification/hybridnetwork/resource-manager/readme.md index ea73acb2d4d6..85150d0356ef 100644 --- a/specification/hybridnetwork/resource-manager/readme.md +++ b/specification/hybridnetwork/resource-manager/readme.md @@ -22,12 +22,34 @@ To see additional help and options, run: These are the global settings for the hybridnetwork. -``` yaml +```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2022-01-01-preview +tag: package-2023-09-01 ``` +### Tag: package-2023-09-01 +These settings apply only when `--tag=package-2023-09-01` is specified on the command line. + +```yaml $(tag) == 'package-2023-09-01' +input-file: + - Microsoft.HybridNetwork/stable/2023-09-01/common.json + - Microsoft.HybridNetwork/stable/2023-09-01/configurationGroupSchema.json + - Microsoft.HybridNetwork/stable/2023-09-01/configurationGroupValues.json + - Microsoft.HybridNetwork/stable/2023-09-01/networkFunction.json + - Microsoft.HybridNetwork/stable/2023-09-01/networkFunctionDefinition.json + - Microsoft.HybridNetwork/stable/2023-09-01/networkServiceDesign.json + - Microsoft.HybridNetwork/stable/2023-09-01/operation.json + - Microsoft.HybridNetwork/stable/2023-09-01/publisher.json + - Microsoft.HybridNetwork/stable/2023-09-01/pureProxyArtifact.json + - Microsoft.HybridNetwork/stable/2023-09-01/site.json + - Microsoft.HybridNetwork/stable/2023-09-01/siteNetworkService.json + +suppressions: + - code: PatchSkuProperty + from: siteNetworkService.json + reason: sku cannot be patched +``` ### Tag: package-2022-01-01-preview